Package com._1c.g5.v8.dt.bsl.documentation.comment

Class BslMultiLineCommentDocumentationProvider

java.lang.Object
org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider
org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider
com._1c.g5.v8.dt.bsl.documentation.comment.BslMultiLineCommentDocumentationProvider
All Implemented Interfaces:
org.eclipse.xtext.documentation.IEObjectDocumentationProvider, org.eclipse.xtext.documentation.IEObjectDocumentationProviderExtension
public class BslMultiLineCommentDocumentationProvider extends org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider
Getting comments content before Method in Bsl

  • 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
    Modifier and Type
    Field
    Description
    static final String
    QL_GRAMMAR_IDENT
     
    static final String
    SKIP_CHECK_IDENT
     
    static final String
    SKIP_WARNING_IDENT
    Deprecated.

    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

  • Constructor Summary

    Constructors
    Constructor
    Description
    BslMultiLineCommentDocumentationProvider()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    findComment(org.eclipse.emf.ecore.EObject object)
    Find all comment nodes nearest o
    List<String>
    getCommentLines(org.eclipse.emf.ecore.EObject object)
    Gets string content of the comment node corresponding to the object line by line
    String
    getDocumentation(org.eclipse.emf.ecore.EObject object)
    Gets string content of the comment nodes corresponding to the object
    List<org.eclipse.xtext.nodemodel.INode>
    getDocumentationNodes(org.eclipse.emf.ecore.EObject object)
    Returns the nearest all one line comment node that precedes the given object.

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

    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

  • Field Details

  • Constructor Details

    • BslMultiLineCommentDocumentationProvider

      public BslMultiLineCommentDocumentationProvider()

  • Method Details

    • getDocumentationNodes

      public List<org.eclipse.xtext.nodemodel.INode> getDocumentationNodes(org.eclipse.emf.ecore.EObject object)
      Returns the nearest all one line comment node that precedes the given object.
      Specified by:
      getDocumentationNodes in interface org.eclipse.xtext.documentation.IEObjectDocumentationProviderExtension
      Overrides:
      getDocumentationNodes in class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider
      Parameters:
      object - object which is looked up documentation
      Returns:
      a list with nodes or an empty list if the object is undocumented.

    • getDocumentation

      public String getDocumentation(org.eclipse.emf.ecore.EObject object)
      Gets string content of the comment nodes corresponding to the object
      Specified by:
      getDocumentation in interface org.eclipse.xtext.documentation.IEObjectDocumentationProvider
      Overrides:
      getDocumentation in class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider
      Parameters:
      object - object for which need to get documentation, cannot be null
      Returns:
      string content of the comment nodes corresponding to the object, never null

    • getCommentLines

      public List<String> getCommentLines(org.eclipse.emf.ecore.EObject object)
      Gets string content of the comment node corresponding to the object line by line
      Parameters:
      object - object for which need to get documentation, cannot be null
      Returns:
      string content of the comment nodes corresponding to the object line by line, never null

    • findComment

      protected String findComment(org.eclipse.emf.ecore.EObject object)
      Find all comment nodes nearest o
      Overrides:
      findComment in class org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider
      Parameters:
      object - object object which is looked up comments, cannot be null