JavadocTokens (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

All Known Implementing Classes:

BindingRegistry, oracle.javatools.parser.java.v2.internal.InternalUtilities, JavadocLexer, SourceFactory, SourceVisitor, oracle.javatools.parser.java.v2.internal.symbol.Sym.SymTraversal, oracle.javatools.parser.java.v2.internal.symbol.SymUtilities
```
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

Fields
Modifier and Type	Field and Description
`static short`	`TAG_AUTHOR` "author"
`static short`	`TAG_base` Base value for tags.
`static short`	`TAG_CODE` "code"
`static short`	`TAG_DEPRECATED` "deprecated"
`static short`	`TAG_DOCROOT` "docRoot"
`static short`	`TAG_EXCEPTION` "exception"
`static short`	`TAG_HIDDEN` "hidden"
`static short`	`TAG_INHERITDOC` "inheritDoc"
`static boolean[]`	`TAG_inline` Identifies the inline tags.
`static short`	`TAG_LINK` "link"
`static short`	`TAG_LINKPLAIN` "linkplain"
`static short`	`TAG_LITERAL` "literal"
`static short`	`TAG_max` Subtracted from TAG_base, this yields the total count of known Javadoc tags.
`static short`	`TAG_PARAM` "param"
`static short`	`TAG_RETURN` "return"
`static short`	`TAG_SEE` "see"
`static short`	`TAG_SERIAL` "serial"
`static short`	`TAG_SERIALDATA` "serialData"
`static short`	`TAG_SERIALFIELD` "serialField"
`static short`	`TAG_SINCE` "since"
`static short`	`TAG_THROWS` "throws"
`static short`	`TAG_unknown` A tag that is not in the table of known tags.
`static short`	`TAG_VALUE` "value"
`static short`	`TAG_VERSION` "version"
`static java.lang.String[]`	`TAG_words` String array, one for each TAG token.
`static short`	`TK_DOC_base`
`static short`	`TK_DOC_COLON` ":"
`static short`	`TK_DOC_COMMA` "."
`static short`	`TK_DOC_DOT` "."
`static short`	`TK_DOC_HASH` "#"
`static short`	`TK_DOC_LBRACE` "{"
`static short`	`TK_DOC_LINE_START` Constant for a line-start on a given doc line.
`static short`	`TK_DOC_LPAREN` "("
`static short`	`TK_DOC_NEWLINE` Constant for a new line.
`static short`	`TK_DOC_RBRACE` "}"
`static short`	`TK_DOC_RPAREN` ")"
`static short`	`TK_DOC_TEXT` Constant for otherwise unclassified text.
`static short`	`TK_DOC_WHITESPACE` Constant for non-newline whitespace.

- Field Detail
  - TK_DOC_base
```
static final short TK_DOC_base
```
    See Also:
    
    Constant Field Values
  - TK_DOC_TEXT
```
static final short TK_DOC_TEXT
```
    Constant for otherwise unclassified text.
    
    See Also:
    
    Constant Field Values
  - TK_DOC_NEWLINE
```
static final short TK_DOC_NEWLINE
```
    Constant for a new line. May be either "\n", "\r", or "\r\n".
    
    See Also:
    
    Constant Field Values
  - TK_DOC_LINE_START
```
static final short TK_DOC_LINE_START
```
    Constant for a line-start on a given doc line. On the first line, the "/**" will be returned as one line-start token. For all of the following, " *" will be return as one line-start token: " *" " *text" " * text" " * *text" " * * text"
    
    See Also:
    
    Constant Field Values
  - TK_DOC_WHITESPACE
```
static final short TK_DOC_WHITESPACE
```
    Constant for non-newline whitespace. This includes ' ' and '\t'.
    
    See Also:
    
    Constant Field Values
  - TK_DOC_COMMA
```
static final short TK_DOC_COMMA
```
    "."
    
    See Also:
    
    Constant Field Values
  - TK_DOC_COLON
```
static final short TK_DOC_COLON
```
    ":"
    
    See Also:
    
    Constant Field Values
  - TK_DOC_DOT
```
static final short TK_DOC_DOT
```
    "."
    
    See Also:
    
    Constant Field Values
  - TK_DOC_HASH
```
static final short TK_DOC_HASH
```
    "#"
    
    See Also:
    
    Constant Field Values
  - TK_DOC_LBRACE
```
static final short TK_DOC_LBRACE
```
    "{"
    
    See Also:
    
    Constant Field Values
  - TK_DOC_LPAREN
```
static final short TK_DOC_LPAREN
```
    "("
    
    See Also:
    
    Constant Field Values
  - TK_DOC_RBRACE
```
static final short TK_DOC_RBRACE
```
    "}"
    
    See Also:
    
    Constant Field Values
  - TK_DOC_RPAREN
```
static final short TK_DOC_RPAREN
```
    ")"
    
    See Also:
    
    Constant Field Values
  - TAG_base
```
static final short TAG_base
```
    Base value for tags.
    
    See Also:
    
    Constant Field Values
  - TAG_unknown
```
static final short TAG_unknown
```
    A tag that is not in the table of known tags.
    
    See Also:
    
    Constant Field Values
  - TAG_AUTHOR
```
static final short TAG_AUTHOR
```
    "author"
    
    See Also:
    
    Constant Field Values
  - TAG_DEPRECATED
```
static final short TAG_DEPRECATED
```
    "deprecated"
    
    See Also:
    
    Constant Field Values
  - TAG_DOCROOT
```
static final short TAG_DOCROOT
```
    "docRoot"
    
    See Also:
    
    Constant Field Values
  - TAG_EXCEPTION
```
static final short TAG_EXCEPTION
```
    "exception"
    
    See Also:
    
    Constant Field Values
  - TAG_LINK
```
static final short TAG_LINK
```
    "link"
    
    See Also:
    
    Constant Field Values
  - TAG_PARAM
```
static final short TAG_PARAM
```
    "param"
    
    See Also:
    
    Constant Field Values
  - TAG_RETURN
```
static final short TAG_RETURN
```
    "return"
    
    See Also:
    
    Constant Field Values
  - TAG_SEE
```
static final short TAG_SEE
```
    "see"
    
    See Also:
    
    Constant Field Values
  - TAG_SERIALDATA
```
static final short TAG_SERIALDATA
```
    "serialData"
    
    See Also:
    
    Constant Field Values
  - TAG_SERIALFIELD
```
static final short TAG_SERIALFIELD
```
    "serialField"
    
    See Also:
    
    Constant Field Values
  - TAG_SINCE
```
static final short TAG_SINCE
```
    "since"
    
    See Also:
    
    Constant Field Values
  - TAG_THROWS
```
static final short TAG_THROWS
```
    "throws"
    
    See Also:
    
    Constant Field Values
  - TAG_VERSION
```
static final short TAG_VERSION
```
    "version"
    
    See Also:
    
    Constant Field Values
  - TAG_INHERITDOC
```
static final short TAG_INHERITDOC
```
    "inheritDoc"
    
    See Also:
    
    Constant Field Values
  - TAG_LINKPLAIN
```
static final short TAG_LINKPLAIN
```
    "linkplain"
    
    See Also:
    
    Constant Field Values
  - TAG_SERIAL
```
static final short TAG_SERIAL
```
    "serial"
    
    See Also:
    
    Constant Field Values
  - TAG_VALUE
```
static final short TAG_VALUE
```
    "value"
    
    See Also:
    
    Constant Field Values
  - TAG_CODE
```
static final short TAG_CODE
```
    "code"
    
    See Also:
    
    Constant Field Values
  - TAG_LITERAL
```
static final short TAG_LITERAL
```
    "literal"
    
    See Also:
    
    Constant Field Values
  - TAG_HIDDEN
```
static final short TAG_HIDDEN
```
    "hidden"
    
    See Also:
    
    Constant Field Values
  - TAG_max
```
static final short TAG_max
```
    Subtracted from TAG_base, this yields the total count of known Javadoc tags.
    
    See Also:
    
    Constant Field Values
  - TAG_words
```
static final java.lang.String[] TAG_words
```
    String array, one for each TAG token. Tag strings do not include the '@'. * TAG_max - TAG_base == TAG_words.length
  - TAG_inline
```
static final boolean[] TAG_inline
```
    Identifies the inline tags. A true means that the TAG_* conforms to the syntax "}. All other tags conform to .

Interface JavadocTokens

Field Summary

Field Detail

TK_DOC_base

TK_DOC_TEXT

TK_DOC_NEWLINE

TK_DOC_LINE_START

TK_DOC_WHITESPACE

TK_DOC_COMMA

TK_DOC_COLON

TK_DOC_DOT

TK_DOC_HASH

TK_DOC_LBRACE

TK_DOC_LPAREN

TK_DOC_RBRACE

TK_DOC_RPAREN

TAG_base

TAG_unknown

TAG_AUTHOR

TAG_DEPRECATED

TAG_DOCROOT

TAG_EXCEPTION

TAG_LINK

TAG_PARAM

TAG_RETURN

TAG_SEE

TAG_SERIALDATA

TAG_SERIALFIELD

TAG_SINCE

TAG_THROWS

TAG_VERSION

TAG_INHERITDOC

TAG_LINKPLAIN

TAG_SERIAL

TAG_VALUE

TAG_CODE

TAG_LITERAL

TAG_HIDDEN

TAG_max

TAG_words

TAG_inline