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 java.lang.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 java.lang.String	END_TAG
protected java.lang.String	endTag
protected java.util.regex.Pattern	endTagRegex
static java.lang.String	LINE_POSTFIX
static java.lang.String	LINE_PREFIX
protected java.lang.String	linePostfix
protected java.util.regex.Pattern	linePostfixRegex
protected java.lang.String	linePrefix
protected java.util.regex.Pattern	linePrefixRegex
static java.lang.String	RULE
protected java.lang.String	ruleName
static java.lang.String	START_TAG
protected java.lang.String	startTag
protected java.util.regex.Pattern	startTagRegex
protected java.util.regex.Pattern	tagsAndPrefixRegex
protected java.lang.String	whitespace
static java.lang.String	WHITESPACE
static java.lang.String	WS_RULE
protected java.lang.String	wsRuleName

Constructor Summary

Constructors

Constructor and Description
AbstractMultiLineCommentProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getTextFromMultilineComment(java.lang.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 java.lang.String RULE

See Also:

Constant Field Values

WS_RULE

public static final java.lang.String WS_RULE

See Also:

Constant Field Values

START_TAG

public static final java.lang.String START_TAG

See Also:

Constant Field Values

END_TAG

public static final java.lang.String END_TAG

See Also:

Constant Field Values

LINE_PREFIX

public static final java.lang.String LINE_PREFIX

See Also:

Constant Field Values

LINE_POSTFIX

public static final java.lang.String LINE_POSTFIX

See Also:

Constant Field Values

WHITESPACE

public static final java.lang.String WHITESPACE

See Also:

Constant Field Values

ruleName

@Inject(optional=true)
protected java.lang.String ruleName

wsRuleName

@Inject(optional=true)
protected java.lang.String wsRuleName

startTag

protected java.lang.String startTag

endTag

protected java.lang.String endTag

linePrefix

protected java.lang.String linePrefix

linePostfix

protected java.lang.String linePostfix

whitespace

protected java.lang.String whitespace

startTagRegex

protected java.util.regex.Pattern startTagRegex

Since:

2.5

endTagRegex

protected java.util.regex.Pattern endTagRegex

Since:

2.5

linePrefixRegex

protected java.util.regex.Pattern linePrefixRegex

Since:

2.5

linePostfixRegex

protected java.util.regex.Pattern linePostfixRegex

Since:

2.5

tagsAndPrefixRegex

protected java.util.regex.Pattern tagsAndPrefixRegex

Since:

2.5

Constructor Detail

AbstractMultiLineCommentProvider

public AbstractMultiLineCommentProvider()

Method Detail

getTextFromMultilineComment

protected java.lang.String getTextFromMultilineComment(java.lang.String returnValue)

injectProperties

@Inject
public void injectProperties(AbstractMultiLineCommentProvider.MultiLineCommentProviderProperties properties)

Since:

2.5