Package com.puppycrawl.tools.checkstyle.api

Class JavadocTokenTypes

java.lang.Object

com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes

public final class JavadocTokenTypes
extends Object

Contains the constants for all the tokens contained in the Abstract Syntax Tree for the javadoc grammar.

See Also:

• javadoc - The Java API Documentation Generator

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AREA_HTML_TAG_NAME	Area tag name.
static final int	AREA_TAG	Area html tag.
static final int	ARGUMENT	Argument definition in PARAMETERS part of REFERENCE.
static final int	ATTR_VALUE	Attribute value html tag component.
static final int	ATTRIBUTE	Html tag attribute.
static final int	AUTHOR_LITERAL	'@author' literal in @author Javadoc tag.
static final int	BASE_HTML_TAG_NAME	Base tag name.
static final int	BASE_TAG	Base html tag.
static final int	BASEFONT_HTML_TAG_NAME	Basefont tag name.
static final int	BASEFONT_TAG	Basefont html tag.
static final int	BODY	Body html tag.
static final int	BODY_HTML_TAG_NAME	Body tag name.
static final int	BODY_TAG_END	End body tag.
static final int	BODY_TAG_START	Start body tag.
static final int	BR_HTML_TAG_NAME	Br tag name.
static final int	BR_TAG	Br html tag.
static final int	CHAR	Any other symbol.
static final int	CLASS_NAME	Exception class name.
static final int	CODE_LITERAL	'@code' literal in {@code} Javadoc inline tag.
static final int	COL_HTML_TAG_NAME	Col tag name.
static final int	COL_TAG	Col html tag.
static final int	COLGROUP	Colgroup html tag.
static final int	COLGROUP_HTML_TAG_NAME	Colgroup tag name.
static final int	COLGROUP_TAG_END	End colgroup tag.
static final int	COLGROUP_TAG_START	Start colgroup tag.
static final int	COMMA	Comma separator between parameters in PARAMETERS part of REFERENCE.
static final int	CUSTOM_NAME	Name of custom Javadoc tag (or Javadoc inline tag).
static final int	DD	Description of a term html tag: <dd></dd>.
static final int	DD_HTML_TAG_NAME	Description of a term tag name.
static final int	DD_TAG_END	End description of a term tag.
static final int	DD_TAG_START	Start description of a term tag.
static final int	DEPRECATED_LITERAL	'@deprecated' literal in @deprecated Javadoc tag.
static final int	DESCRIPTION	Description node.
static final int	DOC_ROOT_LITERAL	'@docRoot' literal in {@docRoot} Javadoc inline tag.
static final int	DT	Description term html tag: <dt></dt>.
static final int	DT_HTML_TAG_NAME	Description term tag name.
static final int	DT_TAG_END	End description term tag.
static final int	DT_TAG_START	Start description term tag.
static final int	EMBED_HTML_TAG_NAME	"embed" tag name.
static final int	EMBED_TAG	HTML void element <embed>.
static final int	EMPTY_TAG	Non-special empty html tag.
static final int	END	End html tag component: '>'.
static final int	EOF	End Of File symbol.
static final int	EQUALS	Equals html tag component: '='.
static final int	EXCEPTION_LITERAL	'@exception' literal in @exception Javadoc tag.
static final int	FIELD_NAME	Field name.
static final int	FIELD_TYPE	Field type.
static final int	FRAME_HTML_TAG_NAME	Frame tag name.
static final int	FRAME_TAG	Frame html tag.
static final int	HASH	Hash character in REFERENCE.
static final int	HEAD	Head html tag.
static final int	HEAD_HTML_TAG_NAME	Head tag name.
static final int	HEAD_TAG_END	End head tag.
static final int	HEAD_TAG_START	Start head tag.
static final int	HR_HTML_TAG_NAME	Hr tag name.
static final int	HR_TAG	Hr html tag.
static final int	HTML	Html html tag.
static final int	HTML_COMMENT	Html comment: <!-- -->.
static final int	HTML_COMMENT_END	HTML comment end symbol '-->'.
static final int	HTML_COMMENT_START	HTML comment start symbol '<!--'.
static final int	HTML_ELEMENT	Parent node for all html tags.
static final int	HTML_ELEMENT_END	End html tag: <XXXX>.
static final int	HTML_ELEMENT_START	Start html tag: <XXXX>.
static final int	HTML_HTML_TAG_NAME	Html tag name.
static final int	HTML_TAG	Non-special HTML tag.
static final int	HTML_TAG_END	End html tag.
static final int	HTML_TAG_NAME	Identifier inside HTML tag: tag name or attribute name.
static final int	HTML_TAG_START	Start html tag.
static final int	IMG_HTML_TAG_NAME	Img tag name.
static final int	IMG_TAG	Img html tag.
static final int	INHERIT_DOC_LITERAL	'@inheritDoc' literal in {@inheritDoc} Javadoc inline tag.
static final int	INPUT_HTML_TAG_NAME	Input tag name.
static final int	INPUT_TAG	Input html tag.
static final int	ISINDEX_HTML_TAG_NAME	Isindex tag name.
static final int	ISINDEX_TAG	Isindex html tag.
static final int	JAVADOC	Root node of any Javadoc comment.
static final int	JAVADOC_INLINE_TAG	Javadoc inline tag.
static final int	JAVADOC_INLINE_TAG_END	Last child of JAVADOC_INLINE_TAG that represents right curly brace '}'.
static final int	JAVADOC_INLINE_TAG_START	First child of JAVADOC_INLINE_TAG that represents left curly brace '{'.
static final int	JAVADOC_TAG	Javadoc tag.
static final int	KEYGEN_HTML_TAG_NAME	"keygen" tag name.
static final int	KEYGEN_TAG	HTML void element <keygen>.
static final int	LEADING_ASTERISK	Leading asterisk.
static final int	LEFT_BRACE	Left brace in PARAMETERS part of REFERENCE.
static final int	LI	List item html tag: <li></li>.
static final int	LI_HTML_TAG_NAME	List item tag name.
static final int	LI_TAG_END	End list item tag.
static final int	LI_TAG_START	Start list item tag.
static final int	LINK_HTML_TAG_NAME	Link tag name.
static final int	LINK_LITERAL	'@link' literal in {@link} Javadoc inline tag.
static final int	LINK_TAG	Link html tag.
static final int	LINKPLAIN_LITERAL	'@linkplain' literal in {@linkplain} Javadoc inline tag.
static final int	LITERAL_EXCLUDE	'exclude' literal.
static final int	LITERAL_INCLUDE	'include' literal.
static final int	LITERAL_LITERAL	'@literal' literal in {@literal} Javadoc inline tag.
static final int	MEMBER	A class member in REFERENCE.
static final int	META_HTML_TAG_NAME	Meta tag name.
static final int	META_TAG	Meta html tag.
static final int	NEWLINE	Newline symbol - '\n'.
static final int	OPTGROUP	`optgroup` html tag.
static final int	OPTGROUP_HTML_TAG_NAME	`optgroup` tag name.
static final int	OPTGROUP_TAG_END	`optgroup` tag end.
static final int	OPTGROUP_TAG_START	`optgroup` tag start.
static final int	OPTION	Option html tag.
static final int	OPTION_HTML_TAG_NAME	Option tag name.
static final int	OPTION_TAG_END	End option tag.
static final int	OPTION_TAG_START	Start option tag.
static final int	P_HTML_TAG_NAME	Paragraph tag name.
static final int	P_TAG_END	End paragraph tag.
static final int	P_TAG_START	Start paragraph tag.
static final int	PACKAGE_CLASS	PACKAGE_CLASS represents the package or class which has been referenced in the `@see`, `@link`, `@linkplain` or `@value` javadoc tags.
static final int	PARAGRAPH	Paragraph html tag: <p></p>.
static final int	PARAM_HTML_TAG_NAME	Param tag name.
static final int	PARAM_LITERAL	'@param' literal in @param Javadoc tag.
static final int	PARAM_TAG	Param html tag.
static final int	PARAMETER_NAME	First argument in @param Javadoc tag.
static final int	PARAMETERS	Parameters part in REFERENCE.
static final int	RB	`rb` html tag.
static final int	RB_HTML_TAG_NAME	`rb` tag name.
static final int	RB_TAG_END	`rb` tag end.
static final int	RB_TAG_START	`rb` tag start.
static final int	REFERENCE	Parameter of the Javadoc tags listed below.
static final int	RETURN_LITERAL	'@return' literal in @return Javadoc tag.
static final int	RIGHT_BRACE	Right brace in PARAMETERS part of REFERENCE.
static final int	RP	`rp` html tag.
static final int	RP_HTML_TAG_NAME	`rp` tag name.
static final int	RP_TAG_END	`rp` tag end.
static final int	RP_TAG_START	`rp` tag start.
static final int	RT	`rt` html tag.
static final int	RT_HTML_TAG_NAME	`rt` tag name.
static final int	RT_TAG_END	`rt` tag end.
static final int	RT_TAG_START	`rt` tag start.
static final int	RTC	`rtc` html tag.
static final int	RTC_HTML_TAG_NAME	`rtc` tag name.
static final int	RTC_TAG_END	`rtc` tag end.
static final int	RTC_TAG_START	`rtc` tag start.
private static final int	RULE_TYPES_OFFSET	Rule types offset.
static final int	SEE_LITERAL	'@see' literal in @see Javadoc tag.
static final int	SERIAL_DATA_LITERAL	'@serialData' literal in @serialData Javadoc tag.
static final int	SERIAL_FIELD_LITERAL	'@serialField' literal in @serialField Javadoc tag.
static final int	SERIAL_LITERAL	'@serial' literal in @serial Javadoc tag.
static final int	SINCE_LITERAL	'@since' literal in @since Javadoc tag.
static final int	SINGLETON_ELEMENT	Parent node for all singleton html tags.
static final int	SLASH	Slash html tag component: '/'.
static final int	SLASH_END	Slash close html tag component: '/>'.
static final int	SOURCE_HTML_TAG_NAME	"source" tag name.
static final int	SOURCE_TAG	HTML void element <source>.
static final int	START	Start html tag component: '<'.
static final int	STRING	Quoted text.
static final int	TBODY	Table body html tag.
static final int	TBODY_HTML_TAG_NAME	Table body tag name.
static final int	TBODY_TAG_END	End table body tag.
static final int	TBODY_TAG_START	Start table body tag.
static final int	TD	Table cell html tag: <td></td>.
static final int	TD_HTML_TAG_NAME	Table cell tag name.
static final int	TD_TAG_END	End table cell tag.
static final int	TD_TAG_START	Start table cell tag.
static final int	TEXT	CHAR and WS sequence.
static final int	TFOOT	Table foot html tag.
static final int	TFOOT_HTML_TAG_NAME	Table foot tag name.
static final int	TFOOT_TAG_END	End table foot tag.
static final int	TFOOT_TAG_START	Start table foot tag.
static final int	TH	Table header cell html tag: <th></th>.
static final int	TH_HTML_TAG_NAME	Table header cell tag name.
static final int	TH_TAG_END	End table header cell tag.
static final int	TH_TAG_START	Start table header cell tag.
static final int	THEAD	Table head html tag.
static final int	THEAD_HTML_TAG_NAME	Table head tag name.
static final int	THEAD_TAG_END	End table head tag.
static final int	THEAD_TAG_START	Start table head tag.
static final int	THROWS_LITERAL	'@throws' literal in @throws Javadoc tag.
static final int	TR	Table row html tag.
static final int	TR_HTML_TAG_NAME	Table row tag name.
static final int	TR_TAG_END	End table row tag.
static final int	TR_TAG_START	Start table row tag.
static final int	TRACK_HTML_TAG_NAME	"track" tag name.
static final int	TRACK_TAG	HTML void element <track>.
static final int	VALUE_LITERAL	'@value' literal in {@value} Javadoc inline tag.
static final int	VERSION_LITERAL	'@version' literal in @version Javadoc tag.
static final int	WBR_HTML_TAG_NAME	"wbr" tag name.
static final int	WBR_TAG	HTML void element <wbr>.
static final int	WS	Whitespace or tab ('\t') symbol.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavadocTokenTypes()	Empty private constructor of the current class.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

RETURN_LITERAL

public static final int RETURN_LITERAL

'@return' literal in @return Javadoc tag.

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@return true if file exists

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
  |--RETURN_LITERAL -> @return
  |--WS ->
  `--DESCRIPTION -> DESCRIPTION
      |--TEXT -> true if file exists
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

DEPRECATED_LITERAL

public static final int DEPRECATED_LITERAL

'@deprecated' literal in @deprecated Javadoc tag.

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@deprecated It is deprecated method

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
  |--DEPRECATED_LITERAL -> @deprecated
  |--WS ->
  `--DESCRIPTION -> DESCRIPTION
      |--TEXT -> It is deprecated method
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

SINCE_LITERAL

public static final int SINCE_LITERAL

'@since' literal in @since Javadoc tag.

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@since 3.4 RELEASE

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
  |--SINCE_LITERAL -> @since
  |--WS ->
  `--DESCRIPTION -> DESCRIPTION
      |--TEXT -> 3.4 RELEASE
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

SERIAL_DATA_LITERAL

public static final int SERIAL_DATA_LITERAL

'@serialData' literal in @serialData Javadoc tag.

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@serialData Two values of Integer type

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
  |--SERIAL_DATA_LITERAL -> @serialData
  |--WS ->
  `--DESCRIPTION -> DESCRIPTION
      |--TEXT -> Two values of Integer type
 
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

SERIAL_FIELD_LITERAL

public static final int SERIAL_FIELD_LITERAL

'@serialField' literal in @serialField Javadoc tag.

Such Javadoc tag can have three arguments:

1. FIELD_NAME
2. FIELD_TYPE
3. DESCRIPTION

Example:

@serialField counter Integer objects counter

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
  |--SERIAL_FIELD_LITERAL -> @serialField
  |--WS ->
  |--FIELD_NAME -> counter
  |--WS ->
  |--FIELD_TYPE -> Integer
  |--WS ->
  `--DESCRIPTION -> DESCRIPTION
      |--TEXT -> objects counter
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

PARAM_LITERAL

public static final int PARAM_LITERAL

'@param' literal in @param Javadoc tag.

Such Javadoc tag can have two arguments:

1. PARAMETER_NAME
2. DESCRIPTION

Example:

@param value The parameter of method.

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
  |--PARAM_LITERAL -> @param
  |--WS ->
  |--PARAMETER_NAME -> value
  |--WS ->
  `--DESCRIPTION -> DESCRIPTION
      |--TEXT -> The parameter of method.
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

SEE_LITERAL

public static final int SEE_LITERAL

'@see' literal in @see Javadoc tag.

Such Javadoc tag can have one argument - REFERENCE

Example:

@see org.apache.utils.Lists.Comparator#compare(Object)

Tree:

   JAVADOC_TAG -> JAVADOC_TAG
    |--SEE_LITERAL -> @see
    |--WS ->
    |--REFERENCE -> REFERENCE
        |--PACKAGE_CLASS -> org.apache.utils.Lists.Comparator
        |--HASH -> #
        |--MEMBER -> compare
        `--PARAMETERS -> PARAMETERS
            |--LEFT_BRACE -> (
            |--ARGUMENT -> Object
            `--RIGHT_BRACE -> )
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

SERIAL_LITERAL

public static final int SERIAL_LITERAL

'@serial' literal in @serial Javadoc tag.

Such Javadoc tag can have one argument - REFERENCE or LITERAL_EXCLUDE or LITERAL_INCLUDE

Example:

@serial include

Tree:

   |--JAVADOC_TAG -> JAVADOC_TAG
       |--SERIAL_LITERAL -> @serial
       |--WS
       |--LITERAL_INCLUDE -> include
 

Example:

@serial serialized company name

Tree:

   |--JAVADOC_TAG-> JAVADOC_TAG
       |--SERIAL_LITERAL -> @serial
       |--WS
       |--DESCRIPTION -> DESCRIPTION
           |--TEXT -> serialized company name
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

VERSION_LITERAL

public static final int VERSION_LITERAL

'@version' literal in @version Javadoc tag.

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@version 1.3

Tree:

   JAVADOC_TAG -> JAVADOC_TAG
    |--VERSION_LITERAL -> @version
    |--WS ->
    `--DESCRIPTION -> DESCRIPTION
        |--TEXT -> 1.3
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

EXCEPTION_LITERAL

public static final int EXCEPTION_LITERAL

'@exception' literal in @exception Javadoc tag.

Such Javadoc tag can have two argument - CLASS_NAME and DESCRIPTION

Example:

@exception SQLException if query is not correct

Tree:

   JAVADOC_TAG -> JAVADOC_TAG
    |--EXCEPTION_LITERAL -> @exception
    |--WS ->
    |--CLASS_NAME -> SQLException
    |--WS ->
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT -> if query is not correct
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

THROWS_LITERAL

public static final int THROWS_LITERAL

'@throws' literal in @throws Javadoc tag.

Such Javadoc tag can have two argument - CLASS_NAME and DESCRIPTION

Example:

@throws SQLException if query is not correct

Tree:

   JAVADOC_TAG -> JAVADOC_TAG
    |--THROWS_LITERAL -> @throws
    |--WS ->
    |--CLASS_NAME -> SQLException
    |--WS ->
    `--DESCRIPTION -> DESCRIPTION
        `--TEXT -> if query is not correct
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

AUTHOR_LITERAL

public static final int AUTHOR_LITERAL

'@author' literal in @author Javadoc tag.

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@author Baratali Izmailov

Tree:

   JAVADOC_TAG -> JAVADOC_TAG
      |--AUTHOR_LITERAL -> @author
      |--WS ->
      `--DESCRIPTION -> DESCRIPTION
          |--TEXT -> Baratali Izmailov
          |--NEWLINE -> \r\n
 

See Also:

• Oracle Docs
• JAVADOC_TAG
• Constant Field Values

CUSTOM_NAME

public static final int CUSTOM_NAME

Name of custom Javadoc tag (or Javadoc inline tag).

Such Javadoc tag can have one argument - DESCRIPTION

Example:

@myJavadocTag some magic

Tree:

   JAVADOC_TAG --> JAVADOC_TAG
       |--CUSTOM_NAME --> @myJavadocTag
       |--WS -->
       `--DESCRIPTION --> DESCRIPTION
           |--TEXT --> some magic
 

See Also:

• Constant Field Values

JAVADOC_INLINE_TAG_START

public static final int JAVADOC_INLINE_TAG_START

First child of JAVADOC_INLINE_TAG that represents left curly brace '{'.

Example:

{@code Comparable<E>}

Tree:

  JAVADOC_INLINE_TAG --> JAVADOC_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START --> {
         |--CODE_LITERAL --> @code
         |--WS -->
         |--TEXT --> Comparable<E>
         `--JAVADOC_INLINE_TAG_END --> }
 
 

See Also:

• Constant Field Values

JAVADOC_INLINE_TAG_END

public static final int JAVADOC_INLINE_TAG_END

Last child of JAVADOC_INLINE_TAG that represents right curly brace '}'.

Example:

{@code Comparable<E>}

Tree:

 JAVADOC_INLINE_TAG --> JAVADOC_INLINE_TAG
        |--JAVADOC_INLINE_TAG_START --> {
        |--CODE_LITERAL --> @code
        |--WS -->
        |--TEXT --> Comparable<E>
        `--JAVADOC_INLINE_TAG_END --> }

 
 

See Also:

• Constant Field Values

CODE_LITERAL

public static final int CODE_LITERAL

'@code' literal in {@code} Javadoc inline tag.

Such Javadoc inline tag can have such child nodes:

• NEWLINE
• WS
• TEXT

Example:

{@code Comparable<E>}

Tree:

 JAVADOC_TAG -> JAVADOC_TAG
        |--CUSTOM_NAME -> @code
        |--WS ->
        `--DESCRIPTION -> DESCRIPTION
            |--TEXT -> Comparable<E>
 
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

DOC_ROOT_LITERAL

public static final int DOC_ROOT_LITERAL

'@docRoot' literal in {@docRoot} Javadoc inline tag.

Such Javadoc inline tag does not have any arguments and can have such child nodes:

• NEWLINE
• WS

Example:

{@docRoot}

Tree:

   |--JAVADOC_INLINE_TAG[1x0] : [{@docRoot}]
            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
            |--DOC_ROOT_LITERAL[1x1] : [@docRoot]
            |--JAVADOC_INLINE_TAG_END[2x0] : [}]
 
 

Example:

{@docRoot
 }

Tree:

   |--JAVADOC_INLINE_TAG[1x0] : [{@docRoot \n}]
            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
            |--DOC_ROOT_LITERAL[1x1] : [@docRoot]
            |--WS[1x9] : [ ]
            |--NEWLINE[1x10] : [\n]
            |--JAVADOC_INLINE_TAG_END[2x0] : [}]
 
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

LINK_LITERAL

public static final int LINK_LITERAL

'@link' literal in {@link} Javadoc inline tag.

Such Javadoc inline tag can have one argument - REFERENCE

Example:

{@link org.apache.utils.Lists.Comparator#compare(Object)}

Tree:

  |--JAVADOC_INLINE_TAG[1x0] :
               [{@link org.apache.utils.Lists.Comparator#compare(Object)}]
        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
        |--LINK_LITERAL[1x1] : [@link]
        |--WS[1x6] : [ ]
        |--REFERENCE[1x7] : [org.apache.utils.Lists.Comparator#compare(Object)]
            |--PACKAGE_CLASS[1x7] : [org.apache.utils]
            |--DOT[1x23] : [.]
            |--CLASS[1x24] : [Lists]
            |--DOT[1x29] : [.]
            |--CLASS[1x30] : [Comparator]
            |--HASH[1x40] : [#]
            |--MEMBER[1x41] : [compare]
            |--PARAMETERS[1x48] : [(Object)]
                |--LEFT_BRACE[1x48] : [(]
                |--ARGUMENT[1x49] : [Object]
                |--RIGHT_BRACE[1x55] : [)]
        |--JAVADOC_INLINE_TAG_END[1x56] : [}]
 
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

INHERIT_DOC_LITERAL

public static final int INHERIT_DOC_LITERAL

'@inheritDoc' literal in {@inheritDoc} Javadoc inline tag.

Such Javadoc inline tag does not have any arguments and can have such child nodes:

• NEWLINE
• WS

Example:

{@inheritDoc}

Tree:

   JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
    |--JAVADOC_INLINE_TAG_START -> {
    |--INHERIT_DOC_LITERAL -> @inheritDoc
    |--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

LINKPLAIN_LITERAL

public static final int LINKPLAIN_LITERAL

'@linkplain' literal in {@linkplain} Javadoc inline tag.

Such Javadoc inline tag can have one argument - REFERENCE

Example:

{@linkplain org.apache.utils.Lists.Comparator#compare(Object) compare}
 

Tree:

   JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
    |--JAVADOC_INLINE_TAG_START -> {
    |--LINKPLAIN_LITERAL -> @linkplain
    |--WS ->
    |--REFERENCE -> org.apache.utils.Lists.Comparator#compare(Object)
        |--PACKAGE_CLASS -> org.apache.utils
        |--DOT -> .
        |--CLASS -> Lists
        |--DOT -> .
        |--CLASS -> Comparator
        |--HASH -> #
        |--MEMBER -> compare
        |--PARAMETERS -> (Object)
            |--LEFT_BRACE -> (
            |--ARGUMENT -> Object
            |--RIGHT_BRACE -> )
     |--DESCRIPTION -> compare
         |--TEXT -> compare
     |--JAVADOC_INLINE_TAG_END -> }
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

LITERAL_LITERAL

public static final int LITERAL_LITERAL

'@literal' literal in {@literal} Javadoc inline tag.

Such Javadoc inline tag can have such child nodes:

• NEWLINE
• WS
• TEXT

Example:

{@literal #compare(Object)}

Tree:

 
     |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
        |--JAVADOC_INLINE_TAG_START -> {
        |--LITERAL_LITERAL -> @literal
        |--WS ->
        |--TEXT -> #compare(Object)
        `--JAVADOC_INLINE_TAG_END -> }
 
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

VALUE_LITERAL

public static final int VALUE_LITERAL

'@value' literal in {@value} Javadoc inline tag.

Such Javadoc inline tag has one argument REFERENCE and can have such child nodes:

• NEWLINE
• WS

Example:

{@value Integer#MAX_VALUE}

Tree:

  JAVADOC_INLINE_TAG --> JAVADOC_INLINE_TAG
         |--JAVADOC_INLINE_TAG_START --> {
         |--VALUE_LITERAL --> @value
         |--WS -->
         |--REFERENCE --> REFERENCE
         |   |--PACKAGE_CLASS --> Integer
         |   |--HASH --> #
         |   `--MEMBER --> MAX_VALUE
         `--JAVADOC_INLINE_TAG_END --> }
 
 

See Also:

• Oracle Docs
• JAVADOC_INLINE_TAG
• Constant Field Values

PACKAGE_CLASS

public static final int PACKAGE_CLASS

PACKAGE_CLASS represents the package or class which has been referenced in the `@see`, `@link`, `@linkplain` or `@value` javadoc tags. In the javadoc tree it shall be a child of REFERENCE.
IMPORTANT: Constructs like package.Class.NestedClassAtDepth1.NestedClassAtDepth2#member are recognized by the javadoc tool from oracle, and no assumptions like, package names wouldn't consist of uppercase characters or class names begin with an uppercase character, are made. Also, the reference in a javadoc tag can consist just a package name or a simple class name or even a full class name. Thus, PACKAGE_CLASS can represent a package name or a simple class name or a full class name i.e. checkstyle doesn't resolve references at present.

Example:

@see org.apache.utils.Lists.Comparator#compare(Object)

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--SEE_LITERAL -&gt @see
  |--WS -&gt
  |--REFERENCE -&gt REFERENCE
  |   |--PACKAGE_CLASS -&gt org.apache.utils.Lists.Comparator
  |   |--HASH -&gt #
  |   |--MEMBER -&gt compare
  |   `--PARAMETERS -&gt PARAMETERS
  |       |--LEFT_BRACE -&gt (
  |       |--ARGUMENT -&gt Object
  |       `--RIGHT_BRACE -&gt )
  |--NEWLINE -&gt \r\n
  `--WS -&gt
 
 

See Also:

• Constant Field Values

HASH

public static final int HASH

Hash character in REFERENCE. Hash character is used before specifying a class member.

Example:

@see org.apache.utils.Lists.Comparator#compare(Object)

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--SEE_LITERAL -&gt @see
  |--WS -&gt
  |--REFERENCE -&gt REFERENCE
      |--PACKAGE_CLASS -&gt org.apache.utils.Lists.Comparator
      |--HASH -&gt #
      |--MEMBER -&gt compare
      `--PARAMETERS -&gt PARAMETERS
          |--LEFT_BRACE -&gt (
          |--ARGUMENT -&gt Object
          `--RIGHT_BRACE -&gt )
 
 

See Also:

• Constant Field Values

MEMBER

public static final int MEMBER

A class member in REFERENCE. Class member is specified after HASH symbol.

Example:

@see org.apache.utils.Lists.Comparator#compare(Object)

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--SEE_LITERAL -&gt @see
  |--WS -&gt
  |--REFERENCE -&gt REFERENCE
      |--PACKAGE_CLASS -&gt org.apache.utils.Lists.Comparator
      |--HASH -&gt #
      |--MEMBER -&gt compare
      `--PARAMETERS -&gt PARAMETERS
          |--LEFT_BRACE -&gt (
          |--ARGUMENT -&gt Object
          `--RIGHT_BRACE -&gt )
 
 

See Also:

• Constant Field Values

LEFT_BRACE

public static final int LEFT_BRACE

Left brace in PARAMETERS part of REFERENCE.

Example:

@see #method(Processor, String)

Tree:

 JAVADOC_TAG -&gt JAVADOC_TAG
         |--SEE_LITERAL -&gt @see
         |--WS -&gt
         |--REFERENCE -&gt REFERENCE
         |   |--HASH -&gt #
         |   |--MEMBER -&gt method
         |   `--PARAMETERS -&gt PARAMETERS
         |       |--LEFT_BRACE -&gt (
         |       |--ARGUMENT -&gt Processor
         |       |--COMMA -&gt ,
         |       |--WS -&gt
         |       |--ARGUMENT -&gt String
         |       `--RIGHT_BRACE -&gt )
 
 

See Also:

• Constant Field Values

RIGHT_BRACE

public static final int RIGHT_BRACE

Right brace in PARAMETERS part of REFERENCE.

Example:

@see #method(Processor, String)

Tree:

 JAVADOC_TAG -&gt JAVADOC_TAG
         |--SEE_LITERAL -&gt @see
         |--WS -&gt
         |--REFERENCE -&gt REFERENCE
         |   |--HASH -&gt #
         |   |--MEMBER -&gt method
         |   `--PARAMETERS -&gt PARAMETERS
         |       |--LEFT_BRACE -&gt (
         |       |--ARGUMENT -&gt Processor
         |       |--COMMA -&gt ,
         |       |--WS -&gt
         |       |--ARGUMENT -&gt String
         |       `--RIGHT_BRACE -&gt )
 
 

See Also:

• Constant Field Values

ARGUMENT

public static final int ARGUMENT

Argument definition in PARAMETERS part of REFERENCE.

Example:

@see #method(Processor, String)

Tree:

 JAVADOC_TAG -&gt JAVADOC_TAG
         |--SEE_LITERAL -&gt @see
         |--WS -&gt
         |--REFERENCE -&gt REFERENCE
         |   |--HASH -&gt #
         |   |--MEMBER -&gt method
         |   `--PARAMETERS -&gt PARAMETERS
         |       |--LEFT_BRACE -&gt (
         |       |--ARGUMENT -&gt Processor
         |       |--COMMA -&gt ,
         |       |--WS -&gt
         |       |--ARGUMENT -&gt String
         |       `--RIGHT_BRACE -&gt )
         `--NEWLINE -&gt \n
 
 

See Also:

• Constant Field Values

COMMA

public static final int COMMA

Comma separator between parameters in PARAMETERS part of REFERENCE.

Example:

@see #method(Processor, String)

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--SEE_LITERAL -&gt @see
  |--WS -&gt
  |--REFERENCE -&gt REFERENCE
  |   |--HASH -&gt #
  |   |--MEMBER -&gt method
  |   `--PARAMETERS -&gt PARAMETERS
  |       |--LEFT_BRACE -&gt (
  |       |--ARGUMENT -&gt Processor
  |       |--COMMA -&gt ,
  |       |--WS -&gt
  |       |--ARGUMENT -&gt String
  |       `--RIGHT_BRACE -&gt )
  |--NEWLINE -&gt \r\n
  `--WS -&gt
 
 

See Also:

• PARAMETERS
• REFERENCE
• ARGUMENT
• Constant Field Values

STRING

public static final int STRING

Quoted text. One of possible @see tag arguments.

Example:

@see "Spring Framework"

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--SEE_LITERAL -&gt @see
  |--WS -&gt
  |--STRING -&gt "Spring Framework"
  |--NEWLINE -&gt \r\n
  `--WS -&gt
 
 

See Also:

• SEE_LITERAL
• Constant Field Values

CLASS_NAME

public static final int CLASS_NAME

Exception class name. First argument in @throws and @exception Javadoc tags.

Example:

@throws IOException connection problems

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--THROWS_LITERAL -&gt @throws
  |--WS -&gt
  |--CLASS_NAME -&gt IOException
  |--WS -&gt
  `--DESCRIPTION -&gt DESCRIPTION
      |--TEXT -&gt connection problems
      |--NEWLINE -&gt \r\n
      `--TEXT -&gt
 
 

See Also:

• EXCEPTION_LITERAL
• THROWS_LITERAL
• Constant Field Values

PARAMETER_NAME

public static final int PARAMETER_NAME

First argument in @param Javadoc tag.

Example:

@param T The bar.

Tree:

 JAVADOC_TAG -&gt JAVADOC_TAG
         |--PARAM_LITERAL -&gt @param
         |--WS -&gt
         |--PARAMETER_NAME -&gt T
         |--WS -&gt
         `--DESCRIPTION -&gt DESCRIPTION
             |--TEXT -&gt The bar.
             |--NEWLINE -&gt \r\n
             `--TEXT -&gt
 
 

See Also:

• Oracle Docs
• PARAM_LITERAL
• Constant Field Values

LITERAL_EXCLUDE

public static final int LITERAL_EXCLUDE

'exclude' literal. One of three possible @serial tag arguments.

Example:

@serial exclude

Tree:

 
   JAVADOC_TAG -> JAVADOC_TAG
    |--SERIAL_LITERAL -> @serial
    |--WS ->
    `--DESCRIPTION -> DESCRIPTION
        |--TEXT -> serialized company name
        |--NEWLINE -> \r\n
        `--TEXT ->
 
 

See Also:

• Oracle Docs
• SERIAL_LITERAL
• Constant Field Values

LITERAL_INCLUDE

public static final int LITERAL_INCLUDE

'include' literal. One of three possible @serial tag arguments.

Example:

@serial include

Tree:

 
 JAVADOC_TAG -&gt JAVADOC_TAG
  |--SERIAL_LITERAL -&gt @serial
  |--WS -&gt
  |--LITERAL_INCLUDE -&gt include
  |--NEWLINE -&gt \r\n
  `--WS -&gt
 
 

See Also:

• Oracle Docs
• SERIAL_LITERAL
• Constant Field Values

FIELD_NAME

public static final int FIELD_NAME

Field name. First argument of @serialField Javadoc tag.

Example:

@serialField counter Integer objects counter

Tree:

 
   JAVADOC_TAG -> JAVADOC_TAG
    |--SERIAL_FIELD_LITERAL -> @serialField
    |--WS ->
    |--FIELD_NAME -> counter
    |--WS ->
    |--FIELD_TYPE -> Integer
    |--WS ->
    `--DESCRIPTION -> DESCRIPTION
        |--TEXT -> objects counter
        |--NEWLINE -> \r\n
        `--TEXT ->
 

See Also:

• Oracle Docs
• SERIAL_FIELD_LITERAL
• Constant Field Values

FIELD_TYPE

public static final int FIELD_TYPE

Field type. Second argument of @serialField Javadoc tag.

Example:

@serialField counter Integer objects counter

Tree:

 JAVADOC_TAG -&gt JAVADOC_TAG
         |--SERIAL_FIELD_LITERAL -&gt @serialField
         |--WS -&gt
         |--FIELD_NAME -&gt counter
         |--WS -&gt
         |--FIELD_TYPE -&gt Integer
         |--WS -&gt
         `--DESCRIPTION -&gt DESCRIPTION
             |--TEXT -&gt objects counter
             `--NEWLINE -&gt \n
 
 

See Also:

• Oracle Docs
• SERIAL_FIELD_LITERAL
• Constant Field Values

HTML_TAG_NAME

public static final int HTML_TAG_NAME

Identifier inside HTML tag: tag name or attribute name.

See Also:

• Constant Field Values

START

public static final int START

Start html tag component: '<'.

See Also:

• Constant Field Values

SLASH

public static final int SLASH

Slash html tag component: '/'.

See Also:

• Constant Field Values

END

public static final int END

End html tag component: '>'.

See Also:

• Constant Field Values

SLASH_END

public static final int SLASH_END

Slash close html tag component: '/>'.

See Also:

• Constant Field Values

EQUALS

public static final int EQUALS

Equals html tag component: '='.

See Also:

• Constant Field Values

ATTR_VALUE

public static final int ATTR_VALUE

Attribute value html tag component.

See Also:

• Constant Field Values

P_HTML_TAG_NAME

public static final int P_HTML_TAG_NAME

Paragraph tag name.

See Also:

• Constant Field Values

LI_HTML_TAG_NAME

public static final int LI_HTML_TAG_NAME

List item tag name.

See Also:

• Constant Field Values

TR_HTML_TAG_NAME

public static final int TR_HTML_TAG_NAME

Table row tag name.

See Also:

• Constant Field Values

TD_HTML_TAG_NAME

public static final int TD_HTML_TAG_NAME

Table cell tag name.

See Also:

• Constant Field Values

TH_HTML_TAG_NAME

public static final int TH_HTML_TAG_NAME

Table header cell tag name.

See Also:

• Constant Field Values

BODY_HTML_TAG_NAME

public static final int BODY_HTML_TAG_NAME

Body tag name.

See Also:

• Constant Field Values

COLGROUP_HTML_TAG_NAME

public static final int COLGROUP_HTML_TAG_NAME

Colgroup tag name.

See Also:

• Constant Field Values

DD_HTML_TAG_NAME

public static final int DD_HTML_TAG_NAME

Description of a term tag name.

See Also:

• Constant Field Values

DT_HTML_TAG_NAME

public static final int DT_HTML_TAG_NAME

Description term tag name.

See Also:

• Constant Field Values

HEAD_HTML_TAG_NAME

public static final int HEAD_HTML_TAG_NAME

Head tag name.

See Also:

• Constant Field Values

HTML_HTML_TAG_NAME

public static final int HTML_HTML_TAG_NAME

Html tag name.

See Also:

• Constant Field Values

OPTION_HTML_TAG_NAME

public static final int OPTION_HTML_TAG_NAME

Option tag name.

See Also:

• Constant Field Values

TBODY_HTML_TAG_NAME

public static final int TBODY_HTML_TAG_NAME

Table body tag name.

See Also:

• Constant Field Values

TFOOT_HTML_TAG_NAME

public static final int TFOOT_HTML_TAG_NAME

Table foot tag name.

See Also:

• Constant Field Values

THEAD_HTML_TAG_NAME

public static final int THEAD_HTML_TAG_NAME

Table head tag name.

See Also:

• Constant Field Values

OPTGROUP_HTML_TAG_NAME

public static final int OPTGROUP_HTML_TAG_NAME

`optgroup` tag name.

See Also:

• Constant Field Values

RB_HTML_TAG_NAME

public static final int RB_HTML_TAG_NAME

`rb` tag name.

See Also:

• Constant Field Values

RT_HTML_TAG_NAME

public static final int RT_HTML_TAG_NAME

`rt` tag name.

See Also:

• Constant Field Values

RTC_HTML_TAG_NAME

public static final int RTC_HTML_TAG_NAME

`rtc` tag name.

See Also:

• Constant Field Values

RP_HTML_TAG_NAME

public static final int RP_HTML_TAG_NAME

`rp` tag name.

See Also:

• Constant Field Values

AREA_HTML_TAG_NAME

public static final int AREA_HTML_TAG_NAME

Area tag name.

See Also:

• Constant Field Values

BASE_HTML_TAG_NAME

public static final int BASE_HTML_TAG_NAME

Base tag name.

See Also:

• Constant Field Values

BASEFONT_HTML_TAG_NAME

public static final int BASEFONT_HTML_TAG_NAME

Basefont tag name.

See Also:

• Constant Field Values

BR_HTML_TAG_NAME

public static final int BR_HTML_TAG_NAME

Br tag name.

Example:

text before break &lt br &gt text after break

Tree:

 
   JAVADOC -> JAVADOC
        |--NEWLINE -> \r\n
        |--LEADING_ASTERISK ->  *
        |--TEXT ->  text before break
        |--HTML_ELEMENT -> HTML_ELEMENT
        |   `--SINGLETON_ELEMENT -> SINGLETON_ELEMENT
        |       `--BR_TAG -> BR_TAG
        |           |--START -> -<
        |           |--BR_HTML_TAG_NAME -> br
        |           `--END -> >
        |--TEXT ->  text after break
        |--NEWLINE -> \r\n
        |--TEXT ->
 
 

See Also:

• Constant Field Values

COL_HTML_TAG_NAME

public static final int COL_HTML_TAG_NAME

Col tag name.

See Also:

• Constant Field Values

FRAME_HTML_TAG_NAME

public static final int FRAME_HTML_TAG_NAME

Frame tag name.

See Also:

• Constant Field Values

HR_HTML_TAG_NAME

public static final int HR_HTML_TAG_NAME

Hr tag name.

See Also:

• Constant Field Values

IMG_HTML_TAG_NAME

public static final int IMG_HTML_TAG_NAME

Img tag name.

See Also:

• Constant Field Values

INPUT_HTML_TAG_NAME

public static final int INPUT_HTML_TAG_NAME

Input tag name.

See Also:

• Constant Field Values

ISINDEX_HTML_TAG_NAME

public static final int ISINDEX_HTML_TAG_NAME

Isindex tag name.

See Also:

• Constant Field Values

LINK_HTML_TAG_NAME

public static final int LINK_HTML_TAG_NAME

Link tag name.

See Also:

• Constant Field Values

META_HTML_TAG_NAME

public static final int META_HTML_TAG_NAME

Meta tag name.

See Also:

• Constant Field Values

PARAM_HTML_TAG_NAME

public static final int PARAM_HTML_TAG_NAME

Param tag name.

See Also:

• Constant Field Values

EMBED_HTML_TAG_NAME

public static final int EMBED_HTML_TAG_NAME

"embed" tag name.

See Also:

• Constant Field Values

KEYGEN_HTML_TAG_NAME

public static final int KEYGEN_HTML_TAG_NAME

"keygen" tag name.

See Also:

• Constant Field Values

SOURCE_HTML_TAG_NAME

public static final int SOURCE_HTML_TAG_NAME

"source" tag name.

See Also:

• Constant Field Values

TRACK_HTML_TAG_NAME

public static final int TRACK_HTML_TAG_NAME

"track" tag name.

See Also:

• Constant Field Values

WBR_HTML_TAG_NAME

public static final int WBR_HTML_TAG_NAME

"wbr" tag name.

See Also:

• Constant Field Values

HTML_COMMENT_START

public static final int HTML_COMMENT_START

HTML comment start symbol '<!--'.

See Also:

• Constant Field Values

HTML_COMMENT_END

public static final int HTML_COMMENT_END

HTML comment end symbol '-->'.

See Also:

• Constant Field Values

LEADING_ASTERISK

public static final int LEADING_ASTERISK

Leading asterisk.

See Also:

• Constant Field Values

NEWLINE

public static final int NEWLINE

Newline symbol - '\n'.

See Also:

• Constant Field Values

CHAR

public static final int CHAR

Any other symbol.

See Also:

• Constant Field Values

WS

public static final int WS

Whitespace or tab ('\t') symbol.

See Also:

• Constant Field Values

EOF

public static final int EOF

End Of File symbol. Copied from Recognizer.EOF to avoid ANTLR dependency in API.

See Also:

• Constant Field Values

RULE_TYPES_OFFSET

private static final int RULE_TYPES_OFFSET

Rule types offset. RULE_TYPES_OFFSET constant is used to split lexer tokens types and parser rules types. We need unique numbers for all tokens, ANTLR do not need this and that is why these types are mixed by used values. All values we can take a look at target/generated-sources/antlr/com/puppycrawl/tools/checkstyle/grammar/javadoc/JavadocParser.java For example: LEADING_ASTERISK=1 and RULE_htmlElement = 1. RULE_TYPES_OFFSET required to shift parser rules, to let them not overlap with types that have prefix "RULE_".

See Also:

• Constant Field Values

JAVADOC

public static final int JAVADOC

Root node of any Javadoc comment. Last child is always EOF.

Tree for example:

 JAVADOC[3x0]
   |--NEWLINE[3x0] : [\n]
   |--LEADING_ASTERISK[4x0] : [ *]
   |--WS[4x2] : [ ]
   |--JAVADOC_TAG[4x3] : [@param T The bar.\n ]
       |--PARAM_LITERAL[4x3] : [@param]
       |--WS[4x9] : [ ]
       |--PARAMETER_NAME[4x10] : [T]
       |--WS[4x11] : [ ]
       |--DESCRIPTION[4x12] : [The bar.\n ]
           |--TEXT[4x12] : [The bar.]
           |--NEWLINE[4x20] : [\n]
           |--TEXT[5x0] : [ ]
   |--EOF[5x1] : [<EOF>]
 

See Also:

• Constant Field Values

JAVADOC_TAG

public static final int JAVADOC_TAG

Javadoc tag.

Type of Javadoc tag is resolved by literal node that is first child of this node.

As literal could be:

• RETURN_LITERAL
• DEPRECATED_LITERAL
• SINCE_LITERAL
• SERIAL_DATA_LITERAL
• SERIAL_FIELD_LITERAL
• PARAM_LITERAL
• SEE_LITERAL
• SERIAL_LITERAL
• VERSION_LITERAL
• EXCEPTION_LITERAL
• THROWS_LITERAL
• AUTHOR_LITERAL
• or CUSTOM_NAME if it is custom Javadoc tag.

Example

@param T The bar.

Tree

 JAVADOC_TAG -&gt JAVADOC_TAG
  |--PARAM_LITERAL -&gt @param
  |--WS -&gt
  |--PARAMETER_NAME -&gt T
  |--WS -&gt
  `--DESCRIPTION -&gt DESCRIPTION
      |--TEXT -&gt The bar.
      |--NEWLINE -&gt \r\n
      `--TEXT -&gt
 

See Also:

• Constant Field Values

JAVADOC_INLINE_TAG

public static final int JAVADOC_INLINE_TAG

Javadoc inline tag.

Type of Javadoc inline tag is resolved by literal node that is second child of this node. First child is always JAVADOC_INLINE_TAG_START and last node is always JAVADOC_INLINE_TAG_END.

As literal could be:

• CODE_LITERAL
• DOC_ROOT_LITERAL
• LINK_LITERAL
• INHERIT_DOC_LITERAL
• LINKPLAIN_LITERAL
• LITERAL_LITERAL
• VALUE_LITERAL
• or CUSTOM_NAME if it is custom Javadoc inline tag.

Example:

{@link String}

Tree:

 
  JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG
      |--JAVADOC_INLINE_TAG_START -> {
      |--LINK_LITERAL -> @link
      |--WS ->
      |--REFERENCE -> REFERENCE
          `--PACKAGE_CLASS -> String
      `--JAVADOC_INLINE_TAG_END -> }
 
 

See Also:

• Constant Field Values

REFERENCE

public static final int REFERENCE

Parameter of the Javadoc tags listed below.

• @see
• {@link}
• {@linkplain}
• {@value}

See Also:

• Constant Field Values

PARAMETERS

public static final int PARAMETERS

Parameters part in REFERENCE. It is used to specify parameters for method. Always contains LEFT_BRACE as first child and RIGHT_BRACE as last child. Each parameter is represented by ARGUMENT node. Arguments in braces are separated by COMMA (and optional WS).

Example:

@see #method(Processor, String)

Tree:

 
      JAVADOC_TAG -> JAVADOC_TAG
          |--SEE_LITERAL -> @see
          |--WS ->
          |--REFERENCE -> REFERENCE
              |--HASH -> #
              |--MEMBER -> method
              `--PARAMETERS -> PARAMETERS
                  |--LEFT_BRACE -> (
                  |--ARGUMENT -> Processor
                  |--COMMA -> ,
                  |--WS ->
                  |--ARGUMENT -> String
                  `--RIGHT_BRACE -> )
 
 

See Also:

• Constant Field Values

DESCRIPTION

public static final int DESCRIPTION

Description node. It contains:

• TEXT
• WS
• NEWLINE
• HTML_ELEMENT

It is argument for many Javadoc tags and inline tags.

Example:

@throws IOException if <b>connection</b> problems occur

Tree:

 
   JAVADOC_TAG -> JAVADOC_TAG
        |--THROWS_LITERAL -> @throws
        |--WS ->
        |--CLASS_NAME -> IOException
        |--WS ->
        `--DESCRIPTION -> DESCRIPTION
            |--TEXT -> if
            |--HTML_ELEMENT -> HTML_ELEMENT
            |    `--HTML_TAG -> HTML_TAG
            |        |--HTML_ELEMENT_START -> HTML_ELEMENT_START
            |        |    |--START -> <
            |        |    |--HTML_TAG_NAME -> b
            |        |    `--END -> >
            |        |--TEXT -> connection
            |        `--HTML_ELEMENT_END -> HTML_ELEMENT_END
            |            |--START -> -<
            |            |--SLASH -> /
            |            |--HTML_TAG_NAME -> b
            |            `--END -> ->
            |--TEXT ->  problems occur
 
 

See Also:

• Constant Field Values

HTML_ELEMENT

public static final int HTML_ELEMENT

Parent node for all html tags.

See Also:

• Constant Field Values

HTML_ELEMENT_START

public static final int HTML_ELEMENT_START

Start html tag: <XXXX>.

See Also:

• Constant Field Values

HTML_ELEMENT_END

public static final int HTML_ELEMENT_END

End html tag: <XXXX>.

See Also:

• Constant Field Values

HTML_TAG

public static final int HTML_TAG

Non-special HTML tag.

See Also:

• Constant Field Values

ATTRIBUTE

public static final int ATTRIBUTE

Html tag attribute. Parent node for: HTML_TAG_IDENT, EQUALS, ATTR_VALUE.

See Also:

• Constant Field Values

PARAGRAPH

public static final int PARAGRAPH

Paragraph html tag: <p></p>.

See Also:

• Constant Field Values

P_TAG_START

public static final int P_TAG_START

Start paragraph tag.

See Also:

• Constant Field Values

P_TAG_END

public static final int P_TAG_END

End paragraph tag.

See Also:

• Constant Field Values

LI

public static final int LI

List item html tag: <li></li>.

See Also:

• Constant Field Values

LI_TAG_START

public static final int LI_TAG_START

Start list item tag.

See Also:

• Constant Field Values

LI_TAG_END

public static final int LI_TAG_END

End list item tag.

See Also:

• Constant Field Values

TR

public static final int TR

Table row html tag.

Example:

<tr></tr>

Tree:

 
   JAVADOC -> JAVADOC
        |--NEWLINE -&gt \r\n
        |--LEADING_ASTERISK -&gt  *
        |--TEXT -&gt
        |--HTML_ELEMENT -&gt HTML_ELEMENT
        |   `--TR -&gt TR
        |       |--TR_TAG_START -&gt TR_TAG_START
        |       |   |--START -&gt &lt
        |       |   |--TR_HTML_TAG_NAME -&gt tr
        |       |   `--END -&gt &gt
        |       `--TR_TAG_END -&gt TR_TAG_END
        |           |--START -&gt &lt
        |           |--SLASH -&gt /
        |           |--TR_HTML_TAG_NAME -&gt tr
        |           `--END -&gt &gt
        |--NEWLINE -&gt \r\n
        |--TEXT -&gt
 
 

See Also:

• Constant Field Values

TR_TAG_START

public static final int TR_TAG_START

Start table row tag.

See Also:

• Constant Field Values

TR_TAG_END

public static final int TR_TAG_END

End table row tag.

See Also:

• Constant Field Values

TD

public static final int TD

Table cell html tag: <td></td>.

See Also:

• Constant Field Values

TD_TAG_START

public static final int TD_TAG_START

Start table cell tag.

See Also:

• Constant Field Values

TD_TAG_END

public static final int TD_TAG_END

End table cell tag.

See Also:

• Constant Field Values

TH

public static final int TH

Table header cell html tag: <th></th>.

See Also:

• Constant Field Values

TH_TAG_START

public static final int TH_TAG_START

Start table header cell tag.

See Also:

• Constant Field Values

TH_TAG_END

public static final int TH_TAG_END

End table header cell tag.

See Also:

• Constant Field Values

BODY

public static final int BODY

Body html tag.

See Also:

• Constant Field Values

BODY_TAG_START

public static final int BODY_TAG_START

Start body tag.

See Also:

• Constant Field Values

BODY_TAG_END

public static final int BODY_TAG_END

End body tag.

See Also:

• Constant Field Values

COLGROUP

public static final int COLGROUP

Colgroup html tag.

See Also:

• Constant Field Values

COLGROUP_TAG_START

public static final int COLGROUP_TAG_START

Start colgroup tag.

See Also:

• Constant Field Values

COLGROUP_TAG_END

public static final int COLGROUP_TAG_END

End colgroup tag.

See Also:

• Constant Field Values

DD

public static final int DD

Description of a term html tag: <dd></dd>.

See Also:

• Constant Field Values

DD_TAG_START

public static final int DD_TAG_START

Start description of a term tag.

See Also:

• Constant Field Values

DD_TAG_END

public static final int DD_TAG_END

End description of a term tag.

See Also:

• Constant Field Values

DT

public static final int DT

Description term html tag: <dt></dt>.

See Also:

• Constant Field Values

DT_TAG_START

public static final int DT_TAG_START

Start description term tag.

See Also:

• Constant Field Values

DT_TAG_END

public static final int DT_TAG_END

End description term tag.

See Also:

• Constant Field Values

HEAD

public static final int HEAD

Head html tag.

See Also:

• Constant Field Values

HEAD_TAG_START

public static final int HEAD_TAG_START

Start head tag.

See Also:

• Constant Field Values

HEAD_TAG_END

public static final int HEAD_TAG_END

End head tag.

See Also:

• Constant Field Values

HTML

public static final int HTML

Html html tag.

See Also:

• Constant Field Values

HTML_TAG_START

public static final int HTML_TAG_START

Start html tag.

See Also:

• Constant Field Values

HTML_TAG_END

public static final int HTML_TAG_END

End html tag.

See Also:

• Constant Field Values

OPTION

public static final int OPTION

Option html tag.

See Also:

• Constant Field Values

OPTION_TAG_START

public static final int OPTION_TAG_START

Start option tag.

See Also:

• Constant Field Values

OPTION_TAG_END

public static final int OPTION_TAG_END

End option tag.

See Also:

• Constant Field Values

TBODY

public static final int TBODY

Table body html tag.

See Also:

• Constant Field Values

TBODY_TAG_START

public static final int TBODY_TAG_START

Start table body tag.

See Also:

• Constant Field Values

TBODY_TAG_END

public static final int TBODY_TAG_END

End table body tag.

See Also:

• Constant Field Values

TFOOT

public static final int TFOOT

Table foot html tag.

See Also:

• Constant Field Values

TFOOT_TAG_START

public static final int TFOOT_TAG_START

Start table foot tag.

See Also:

• Constant Field Values

TFOOT_TAG_END

public static final int TFOOT_TAG_END

End table foot tag.

See Also:

• Constant Field Values

THEAD

public static final int THEAD

Table head html tag.

See Also:

• Constant Field Values

THEAD_TAG_START

public static final int THEAD_TAG_START

Start table head tag.

See Also:

• Constant Field Values

THEAD_TAG_END

public static final int THEAD_TAG_END

End table head tag.

See Also:

• Constant Field Values

OPTGROUP

public static final int OPTGROUP

`optgroup` html tag.

See Also:

• Constant Field Values

OPTGROUP_TAG_START

public static final int OPTGROUP_TAG_START

`optgroup` tag start.

See Also:

• Constant Field Values

OPTGROUP_TAG_END

public static final int OPTGROUP_TAG_END

`optgroup` tag end.

See Also:

• Constant Field Values

RB

public static final int RB

`rb` html tag.

See Also:

• Constant Field Values

RB_TAG_START

public static final int RB_TAG_START

`rb` tag start.

See Also:

• Constant Field Values

RB_TAG_END

public static final int RB_TAG_END

`rb` tag end.

See Also:

• Constant Field Values

RT

public static final int RT

`rt` html tag.

See Also:

• Constant Field Values

RT_TAG_START

public static final int RT_TAG_START

`rt` tag start.

See Also:

• Constant Field Values

RT_TAG_END

public static final int RT_TAG_END

`rt` tag end.

See Also:

• Constant Field Values

RTC

public static final int RTC

`rtc` html tag.

See Also:

• Constant Field Values

RTC_TAG_START

public static final int RTC_TAG_START

`rtc` tag start.

See Also:

• Constant Field Values

RTC_TAG_END

public static final int RTC_TAG_END

`rtc` tag end.

See Also:

• Constant Field Values

RP

public static final int RP

`rp` html tag.

See Also:

• Constant Field Values

RP_TAG_START

public static final int RP_TAG_START

`rp` tag start.

See Also:

• Constant Field Values

RP_TAG_END

public static final int RP_TAG_END

`rp` tag end.

See Also:

• Constant Field Values

SINGLETON_ELEMENT

public static final int SINGLETON_ELEMENT

Parent node for all singleton html tags.

See Also:

• Constant Field Values

EMPTY_TAG

public static final int EMPTY_TAG

Non-special empty html tag.

See Also:

• Constant Field Values

AREA_TAG

public static final int AREA_TAG

Area html tag.

See Also:

• Constant Field Values

BASE_TAG

public static final int BASE_TAG

Base html tag.

See Also:

• Constant Field Values

BASEFONT_TAG

public static final int BASEFONT_TAG

Basefont html tag.

See Also:

• Constant Field Values

BR_TAG

public static final int BR_TAG

Br html tag.

See Also:

• Constant Field Values

COL_TAG

public static final int COL_TAG

Col html tag.

See Also:

• Constant Field Values

FRAME_TAG

public static final int FRAME_TAG

Frame html tag.

See Also:

• Constant Field Values

HR_TAG

public static final int HR_TAG

Hr html tag.

See Also:

• Constant Field Values

IMG_TAG

public static final int IMG_TAG

Img html tag.

See Also:

• Constant Field Values

INPUT_TAG

public static final int INPUT_TAG

Input html tag.

See Also:

• Constant Field Values

ISINDEX_TAG

public static final int ISINDEX_TAG

Isindex html tag.

See Also:

• Constant Field Values

LINK_TAG

public static final int LINK_TAG

Link html tag.

See Also:

• Constant Field Values

META_TAG

public static final int META_TAG

Meta html tag.

See Also:

• Constant Field Values

PARAM_TAG

public static final int PARAM_TAG

Param html tag.

See Also:

• Constant Field Values

EMBED_TAG

public static final int EMBED_TAG

HTML void element <embed>.

See Also:

• SINGLETON_ELEMENT
• W3 docs
• Constant Field Values

KEYGEN_TAG

public static final int KEYGEN_TAG

HTML void element <keygen>.

See Also:

• SINGLETON_ELEMENT
• W3 docs
• Constant Field Values

SOURCE_TAG

public static final int SOURCE_TAG

HTML void element <source>.

See Also:

• SINGLETON_ELEMENT
• W3 docs
• Constant Field Values

TRACK_TAG

public static final int TRACK_TAG

HTML void element <track>.

See Also:

• SINGLETON_ELEMENT
• W3 docs
• Constant Field Values

WBR_TAG

public static final int WBR_TAG

HTML void element <wbr>.

See Also:

• SINGLETON_ELEMENT
• W3 docs
• Constant Field Values

HTML_COMMENT

public static final int HTML_COMMENT

Html comment: <!-- -->.

See Also:

• Constant Field Values

TEXT

public static final int TEXT

CHAR and WS sequence.

See Also:

• Constant Field Values

Constructor Details

JavadocTokenTypes

private JavadocTokenTypes()

Empty private constructor of the current class.