org.eclipse.xtext.documentation.impl

Class MultiLineCommentDocumentationProvider

java.lang.Object

org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider

org.eclipse.xtext.documentation.impl.MultiLineCommentDocumentationProvider

All Implemented Interfaces:

IEObjectDocumentationProvider, IEObjectDocumentationProviderExtension

public class MultiLineCommentDocumentationProvider
extends AbstractMultiLineCommentProvider
implements IEObjectDocumentationProvider, IEObjectDocumentationProviderExtension

The default implementation of the documentation provider for emf objects based on Xtext languages. It uses a single ML_COMMENT token by default to return the contained text as the documentation.

Author:

Christoph Kulla - Initial contribution and API

Nested Class Summary

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

AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties

Field Summary

Fields

Modifier and Type	Field and Description
protected Pattern	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 and Description
MultiLineCommentDocumentationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	findComment(org.eclipse.emf.ecore.EObject o)
String	getDocumentation(org.eclipse.emf.ecore.EObject o) returns the documentation or null if no documentation is attached to the given EObject.
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)

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 Detail

commentStartTagRegex

protected Pattern commentStartTagRegex

Since:

2.5

Constructor Detail

MultiLineCommentDocumentationProvider

public MultiLineCommentDocumentationProvider()

Method Detail

findComment

protected String findComment(org.eclipse.emf.ecore.EObject o)

getDocumentationNodes

public List<INode> getDocumentationNodes(org.eclipse.emf.ecore.EObject object)

Returns the nearest multi line comment node that precedes the given object.

Specified by:

getDocumentationNodes in interface IEObjectDocumentationProviderExtension

Returns:

a list with exactly one node or an empty list if the object is undocumented.

Since:

2.3

getDocumentation

public String getDocumentation(org.eclipse.emf.ecore.EObject o)

Description copied from interface: IEObjectDocumentationProvider

returns the documentation or null if no documentation is attached to the given EObject.

Specified by:

getDocumentation in interface IEObjectDocumentationProvider

injectProperties

@Inject
public void injectProperties(AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties properties)

Overrides:

injectProperties in class AbstractMultiLineCommentProvider

Since:

2.5