org.eclipse.xtext.documentation.impl

Class MultiLineFileHeaderProvider

java.lang.Object

org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider

org.eclipse.xtext.documentation.impl.MultiLineFileHeaderProvider

All Implemented Interfaces:

IFileHeaderProvider

public class MultiLineFileHeaderProvider
extends AbstractMultiLineCommentProvider
implements IFileHeaderProvider

Since:

2.4

Nested Class Summary

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

AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties

Field Summary

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
MultiLineFileHeaderProvider()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	findFileHeader(org.eclipse.emf.ecore.resource.Resource resource)
java.lang.String	getFileHeader(org.eclipse.emf.ecore.resource.Resource resource)
java.util.List<INode>	getFileHeaderNodes(org.eclipse.emf.ecore.resource.Resource resource) Returns the first non-whitespace leaf node in the file if it is a multi-line comment node.

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

getTextFromMultilineComment, injectProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiLineFileHeaderProvider

public MultiLineFileHeaderProvider()

Method Detail

findFileHeader

protected java.lang.String findFileHeader(org.eclipse.emf.ecore.resource.Resource resource)

getFileHeaderNodes

public java.util.List<INode> getFileHeaderNodes(org.eclipse.emf.ecore.resource.Resource resource)

Returns the first non-whitespace leaf node in the file if it is a multi-line comment node.

Specified by:

getFileHeaderNodes in interface IFileHeaderProvider

Returns:

a list with exactly one node or an empty list if there is no header is undocumented.

Since:

2.3

getFileHeader

public java.lang.String getFileHeader(org.eclipse.emf.ecore.resource.Resource resource)

Specified by:

getFileHeader in interface IFileHeaderProvider