Package tools.refinery.language.documentation

Class DocumentationCommentParser

java.lang.Object

tools.refinery.language.documentation.DocumentationCommentParser

public class DocumentationCommentParser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_PARAMETER_NAME
static final String	COLOR_TAG
static final String	DOCUMENTATION
static final String	ENUM_PARAMETER_NAME
static final String	REFERENCE_SOURCE_PARAMETER_NAME
static final String	REFERENCE_TARGET_PARAMETER_NAME

Constructor Summary

Constructors

Constructor	Description
DocumentationCommentParser()

Method Summary

Modifier and Type	Method	Description
@Nullable String	getDocumentation(org.eclipse.emf.ecore.EObject eObject)
@NotNull ParsedDocumentation	getParsedDocumentation(org.eclipse.emf.ecore.EObject eObject)
@NotNull Map<String,String>	parseDocumentation(org.eclipse.emf.ecore.EObject eObject)

Methods inherited from class java.lang.Object

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

Field Details

CLASS_PARAMETER_NAME

public static final String CLASS_PARAMETER_NAME

See Also:

• Constant Field Values

ENUM_PARAMETER_NAME

public static final String ENUM_PARAMETER_NAME

See Also:

• Constant Field Values

REFERENCE_SOURCE_PARAMETER_NAME

public static final String REFERENCE_SOURCE_PARAMETER_NAME

See Also:

• Constant Field Values

REFERENCE_TARGET_PARAMETER_NAME

public static final String REFERENCE_TARGET_PARAMETER_NAME

See Also:

• Constant Field Values

COLOR_TAG

public static final String COLOR_TAG

See Also:

• Constant Field Values

DOCUMENTATION

public static final String DOCUMENTATION

See Also:

• Constant Field Values

Constructor Details

DocumentationCommentParser

public DocumentationCommentParser()

Method Details

getDocumentation

@Nullable
public @Nullable String getDocumentation(org.eclipse.emf.ecore.EObject eObject)

parseDocumentation

@NotNull
public @NotNull Map<String,String> parseDocumentation(org.eclipse.emf.ecore.EObject eObject)

getParsedDocumentation

@NotNull
public @NotNull ParsedDocumentation getParsedDocumentation(org.eclipse.emf.ecore.EObject eObject)