public class MultiLineCommentDocumentationProvider extends AbstractMultiLineCommentProvider implements IEObjectDocumentationProvider, IEObjectDocumentationProviderExtension
emf objects
based
on Xtext languages.
It uses a single ML_COMMENT token by default to return the contained text as the documentation.AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties
Modifier and Type | Field and Description |
---|---|
protected java.util.regex.Pattern |
commentStartTagRegex |
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 and Description |
---|
MultiLineCommentDocumentationProvider() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
findComment(org.eclipse.emf.ecore.EObject o) |
java.lang.String |
getDocumentation(org.eclipse.emf.ecore.EObject o)
returns the documentation or
null if no documentation is attached to the given EObject . |
java.util.List<INode> |
getDocumentationNodes(org.eclipse.emf.ecore.EObject object)
Returns the nearest multi line comment node that precedes the given object.
|
void |
injectProperties(AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties properties) |
getTextFromMultilineComment
public MultiLineCommentDocumentationProvider()
protected java.lang.String findComment(org.eclipse.emf.ecore.EObject o)
public java.util.List<INode> getDocumentationNodes(org.eclipse.emf.ecore.EObject object)
getDocumentationNodes
in interface IEObjectDocumentationProviderExtension
public java.lang.String getDocumentation(org.eclipse.emf.ecore.EObject o)
IEObjectDocumentationProvider
null
if no documentation is attached to the given EObject
.getDocumentation
in interface IEObjectDocumentationProvider
@Inject public void injectProperties(AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties properties)
injectProperties
in class AbstractMultiLineCommentProvider