Package de.gebit.integrity.utils

Class ParsedDocumentationComment.DocCommentElement

java.lang.Object

de.gebit.integrity.utils.ParsedDocumentationComment.DocCommentElement

Enclosing class:

ParsedDocumentationComment

public static final class ParsedDocumentationComment.DocCommentElement
extends Object

A single element of a documentation comment. Can be a textual element or a structural formatting information.

Author:

Rene Schneider - initial API and implementation

Constructor Summary

Constructors

Constructor	Description
DocCommentElement(String aText, ParsedDocumentationComment.DocCommentElementType aType, boolean aTerminalFlag)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getText()
ParsedDocumentationComment.DocCommentElementType	getType()
boolean	isTerminal()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocCommentElement

public DocCommentElement(String aText,
                         ParsedDocumentationComment.DocCommentElementType aType,
                         boolean aTerminalFlag)

Constructor.

Parameters:

aText -

aType -

aTerminalFlag -

Method Detail

getText

public String getText()

getType

public ParsedDocumentationComment.DocCommentElementType getType()

isTerminal

public boolean isTerminal()