org.eclipse.xtext.documentation.impl

Class AbstractMultiLineCommentProvider

java.lang.Object

org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider

Direct Known Subclasses:

MultiLineCommentDocumentationProvider, MultiLineFileHeaderProvider

public class AbstractMultiLineCommentProvider
extends Object

Since:

2.4

Author:

Jan Koehnlein - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_TAG
protected String	endTag
protected Pattern	endTagRegex
static String	LINE_POSTFIX
static String	LINE_PREFIX
protected String	linePostfix
protected Pattern	linePostfixRegex
protected String	linePrefix
protected Pattern	linePrefixRegex
static String	RULE
protected String	ruleName
static String	START_TAG
protected String	startTag
protected Pattern	startTagRegex
protected Pattern	tagsAndPrefixRegex
protected String	whitespace
static String	WHITESPACE
static String	WS_RULE
protected String	wsRuleName

Constructor Summary

Constructors

Constructor and Description
AbstractMultiLineCommentProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getTextFromMultilineComment(String returnValue)
void	injectProperties(AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties properties)

Methods inherited from class java.lang.Object

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

Field Detail

RULE

public static final String RULE

See Also:

Constant Field Values

WS_RULE

public static final String WS_RULE

See Also:

Constant Field Values

START_TAG

public static final String START_TAG

See Also:

Constant Field Values

END_TAG

public static final String END_TAG

See Also:

Constant Field Values

LINE_PREFIX

public static final String LINE_PREFIX

See Also:

Constant Field Values

LINE_POSTFIX

public static final String LINE_POSTFIX

See Also:

Constant Field Values

WHITESPACE

public static final String WHITESPACE

See Also:

Constant Field Values

ruleName

@Inject(optional=true)
protected String ruleName

wsRuleName

@Inject(optional=true)
protected String wsRuleName

startTag

protected String startTag

endTag

protected String endTag

linePrefix

protected String linePrefix

linePostfix

protected String linePostfix

whitespace

protected String whitespace

startTagRegex

protected Pattern startTagRegex

Since:

2.5

endTagRegex

protected Pattern endTagRegex

Since:

2.5

linePrefixRegex

protected Pattern linePrefixRegex

Since:

2.5

linePostfixRegex

protected Pattern linePostfixRegex

Since:

2.5

tagsAndPrefixRegex

protected Pattern tagsAndPrefixRegex

Since:

2.5

Constructor Detail

AbstractMultiLineCommentProvider

public AbstractMultiLineCommentProvider()

Method Detail

getTextFromMultilineComment

protected String getTextFromMultilineComment(String returnValue)

injectProperties

@Inject
public void injectProperties(AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties properties)

Since:

2.5