oracle.javatools.parser.java.v1
Interface JavaDocTokens

All Known Implementing Classes:

CommentSymbol, JavaDocLexer

public interface JavaDocTokens

The JavaDocTokens interface defines the constants for the various tokens of the a JavaDoc comment in the Java Language. Details of the language taken from Java Language Specification

Note to maintainer - make sure these constants all have different values from JavaTokens.

See Also:

JavaTokens, JavaDocLexer

Field Summary

static int	TK_DOC_AUTHOR Constant for the JavaDoc @author tag.
static int	TK_DOC_COMMENTTEXT Comment for the comment text which is not associated with a specific JavaDoc tag.
static int	TK_DOC_DEPRECATED Constant for the JavaDoc @deprecated tag.
static int	TK_DOC_EXCEPTION Constant for the JavaDoc @exception tag.
static int	TK_DOC_HIDDEN Constant for the JavaDoc @hidden tag.
static int	TK_DOC_PARAM Constant for the JavaDoc @param tag.
static int	TK_DOC_RETURN Constant for the JavaDoc @return tag.
static int	TK_DOC_SEE Constant for the JavaDoc @see tag.
static int	TK_DOC_SERIAL Constant for the JavaDoc @serial tag.
static int	TK_DOC_SERIALDATA Constant for the JavaDoc @serialData tag.
static int	TK_DOC_SERIALFIELD Constant for the JavaDoc @serialField tag.
static int	TK_DOC_SINCE Constant for the JavaDoc @since tag.
static int	TK_DOC_TAGTEXT Constant for the text associated with a specific JavaDoc tag.
static int	TK_DOC_THROWS Constant for the JavaDoc @throws tag.
static int	TK_DOC_UNKNOWNTAG Constant for an unknown JavaDoc tag - for example, this may be an internal tag used by developers on a specific project.
static int	TK_DOC_VERSION Constant for the JavaDoc @version tag.

Field Detail

TK_DOC_TAGTEXT

static final int TK_DOC_TAGTEXT

Constant for the text associated with a specific JavaDoc tag. For example, the text following an @param tag.

See Also:

Constant Field Values

TK_DOC_COMMENTTEXT

static final int TK_DOC_COMMENTTEXT

Comment for the comment text which is not associated with a specific JavaDoc tag. The comment text does not include the initial asterisk(s) "*" at the start of a line.

See Also:

Constant Field Values

TK_DOC_UNKNOWNTAG

static final int TK_DOC_UNKNOWNTAG

Constant for an unknown JavaDoc tag - for example, this may be an internal tag used by developers on a specific project.

See Also:

Constant Field Values

TK_DOC_AUTHOR

static final int TK_DOC_AUTHOR

Constant for the JavaDoc @author tag.

See Also:

Constant Field Values

TK_DOC_DEPRECATED

static final int TK_DOC_DEPRECATED

Constant for the JavaDoc @deprecated tag.

See Also:

Constant Field Values

TK_DOC_EXCEPTION

static final int TK_DOC_EXCEPTION

Constant for the JavaDoc @exception tag.

See Also:

Constant Field Values

TK_DOC_HIDDEN

static final int TK_DOC_HIDDEN

Constant for the JavaDoc @hidden tag. See bug 2798659.

See Also:

Constant Field Values

TK_DOC_PARAM

static final int TK_DOC_PARAM

Constant for the JavaDoc @param tag.

See Also:

Constant Field Values

TK_DOC_RETURN

static final int TK_DOC_RETURN

Constant for the JavaDoc @return tag.

See Also:

Constant Field Values

TK_DOC_SEE

static final int TK_DOC_SEE

Constant for the JavaDoc @see tag.

See Also:

Constant Field Values

TK_DOC_SERIAL

static final int TK_DOC_SERIAL

Constant for the JavaDoc @serial tag.

See Also:

Constant Field Values

TK_DOC_SERIALDATA

static final int TK_DOC_SERIALDATA

Constant for the JavaDoc @serialData tag.

See Also:

Constant Field Values

TK_DOC_SERIALFIELD

static final int TK_DOC_SERIALFIELD

Constant for the JavaDoc @serialField tag.

See Also:

Constant Field Values

TK_DOC_SINCE

static final int TK_DOC_SINCE

Constant for the JavaDoc @since tag.

See Also:

Constant Field Values

TK_DOC_THROWS

static final int TK_DOC_THROWS

Constant for the JavaDoc @throws tag.

See Also:

Constant Field Values

TK_DOC_VERSION

static final int TK_DOC_VERSION

Constant for the JavaDoc @version tag.

See Also:

Constant Field Values