Package org.eclipse.xtend.core.documentation

Class XtendDocumentationProvider

  • All Implemented Interfaces:
    org.eclipse.xtext.documentation.IEObjectDocumentationProvider, org.eclipse.xtext.documentation.IEObjectDocumentationProviderExtension
    public class XtendDocumentationProvider
extends org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider

        org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties

    • Field Summary

      • Fields inherited from class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider

        commentStartTagRegex

      • Fields inherited from class org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider

        END_TAG, endTag, endTagRegex, LINE_POSTFIX, LINE_PREFIX, linePostfix, linePostfixRegex, linePrefix, linePrefixRegex, RULE, ruleName, START_TAG, startTag, startTagRegex, tagsAndPrefixRegex, whitespace, WHITESPACE, WS_RULE, wsRuleName

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDocumentation​(org.eclipse.emf.ecore.EObject o)  
      java.util.List<org.eclipse.xtext.nodemodel.INode> getDocumentationNodes​(org.eclipse.emf.ecore.EObject o)  
      boolean shouldBeHandled​(org.eclipse.emf.ecore.EObject o)
      The Xtend parser constructs a synthetic nested AST element to hold annotations which should be ignored as a documentation provider

      • Methods inherited from class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider

        findComment, injectProperties

      • Methods inherited from class org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider

        getTextFromMultilineComment

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • XtendDocumentationProvider

        public XtendDocumentationProvider()

    • Method Detail

      • getDocumentation

        public java.lang.String getDocumentation​(org.eclipse.emf.ecore.EObject o)
        Specified by:
        getDocumentation in interface org.eclipse.xtext.documentation.IEObjectDocumentationProvider
        Overrides:
        getDocumentation in class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider

      • getDocumentationNodes

        public java.util.List<org.eclipse.xtext.nodemodel.INode> getDocumentationNodes​(org.eclipse.emf.ecore.EObject o)
        Specified by:
        getDocumentationNodes in interface org.eclipse.xtext.documentation.IEObjectDocumentationProviderExtension
        Overrides:
        getDocumentationNodes in class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider

      • shouldBeHandled

        public boolean shouldBeHandled​(org.eclipse.emf.ecore.EObject o)
        The Xtend parser constructs a synthetic nested AST element to hold annotations which should be ignored as a documentation provider