Package org.aspectj.org.eclipse.jdt.internal.compiler.parser

Interface JavadocTagConstants

All Known Implementing Classes:

AbstractCommentParser, CompletionJavadocParser, CompletionOnJavadocTag, JavadocParser, SelectionJavadocParser, SourceJavadocParser

public interface JavadocTagConstants

Javadoc tag constants.

Since:

3.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	JavadocTagConstants.LevelTags	A record class representing additional tags to be made available at specific java version levels.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL_TAGS_LENGTH
static final int	BLOCK_IDX
static final char[][][]	BLOCK_TAGS
static final int	BLOCK_TAGS_LENGTH
static final JavadocTagConstants.LevelTags[]	BLOCK_TAGS_RAW
static final char[][]	CLASS_TAGS
static final char[][]	COMPILATION_UNIT_TAGS
static final char[][]	FIELD_TAGS
static final char[]	HREF_TAG
static final char[][][]	IN_SNIPPET_TAGS
static final int	IN_SNIPPET_TAGS_LENGTH
static final int	INLINE_IDX
static final char[][][]	INLINE_TAGS
static final int	INLINE_TAGS_LENGTH
static final JavadocTagConstants.LevelTags[]	INLINE_TAGS_RAW
static final short[]	JAVADOC_TAG_TYPE
static final short[]	JAVADOC_TAG_TYPE_16PLUS
static final char[][]	METHOD_TAGS
static final char[][]	MODULE_TAGS
static final int	NO_TAG_VALUE
static final int	ORDERED_TAGS_NUMBER
static final char[][]	PACKAGE_TAGS
static final int	PARAM_TAG_EXPECTED_ORDER
static final int	SEE_TAG_EXPECTED_ORDER
static final int	SNIPPET_IDX
static final int	SNIPPET_TAGS_LENGTH
static final char[]	TAG_API_NOTE
static final int	TAG_API_NOTE_LENGTH
static final int	TAG_API_NOTE_VALUE
static final char[]	TAG_AUTHOR
static final int	TAG_AUTHOR_LENGTH
static final int	TAG_AUTHOR_VALUE
static final char[]	TAG_CATEGORY
static final int	TAG_CATEGORY_LENGTH
static final int	TAG_CATEGORY_VALUE
static final char[]	TAG_CODE
static final int	TAG_CODE_LENGTH
static final int	TAG_CODE_VALUE
static final char[]	TAG_DEPRECATED
static final int	TAG_DEPRECATED_LENGTH
static final int	TAG_DEPRECATED_VALUE
static final char[]	TAG_DOC_ROOT
static final int	TAG_DOC_ROOT_LENGTH
static final int	TAG_DOC_ROOT_VALUE
static final char[]	TAG_EXCEPTION
static final int	TAG_EXCEPTION_LENGTH
static final int	TAG_EXCEPTION_VALUE
static final char[]	TAG_HIDDEN
static final int	TAG_HIDDEN_LENGTH
static final int	TAG_HIDDEN_VALUE
static final char[]	TAG_HIGHLIGHT
static final int	TAG_HIGHLIGHT_LENGTH
static final int	TAG_HIGHLIGHT_VALUE
static final char[]	TAG_IMPL_NOTE
static final int	TAG_IMPL_NOTE_LENGTH
static final int	TAG_IMPL_NOTE_VALUE
static final char[]	TAG_IMPL_SPEC
static final int	TAG_IMPL_SPEC_LENGTH
static final int	TAG_IMPL_SPEC_VALUE
static final char[]	TAG_INDEX
static final int	TAG_INDEX_LENGTH
static final int	TAG_INDEX_VALUE
static final char[]	TAG_INHERITDOC
static final int	TAG_INHERITDOC_LENGTH
static final int	TAG_INHERITDOC_VALUE
static final char[]	TAG_LINK
static final int	TAG_LINK_LENGTH
static final int	TAG_LINK_VALUE
static final char[]	TAG_LINKPLAIN
static final int	TAG_LINKPLAIN_LENGTH
static final int	TAG_LINKPLAIN_VALUE
static final char[]	TAG_LITERAL
static final int	TAG_LITERAL_LENGTH
static final int	TAG_LITERAL_VALUE
static final char[][]	TAG_NAMES
static final int	TAG_OTHERS_VALUE
static final char[]	TAG_PARAM
static final int	TAG_PARAM_LENGTH
static final int	TAG_PARAM_VALUE
static final char[]	TAG_PROVIDES
static final int	TAG_PROVIDES_LENGTH
static final int	TAG_PROVIDES_VALUE
static final char[]	TAG_REPLACE
static final int	TAG_REPLACE_LENGTH
static final int	TAG_REPLACE_VALUE
static final char[]	TAG_RETURN
static final int	TAG_RETURN_LENGTH
static final int	TAG_RETURN_VALUE
static final char[]	TAG_SEE
static final int	TAG_SEE_LENGTH
static final int	TAG_SEE_VALUE
static final char[]	TAG_SERIAL
static final char[]	TAG_SERIAL_DATA
static final int	TAG_SERIAL_DATA_LENGTH
static final int	TAG_SERIAL_DATA_VALUE
static final char[]	TAG_SERIAL_FIELD
static final int	TAG_SERIAL_FIELD_LENGTH
static final int	TAG_SERIAL_FIELD_VALUE
static final int	TAG_SERIAL_LENGTH
static final int	TAG_SERIAL_VALUE
static final char[]	TAG_SINCE
static final int	TAG_SINCE_LENGTH
static final int	TAG_SINCE_VALUE
static final char[]	TAG_SNIPPET
static final int	TAG_SNIPPET_LENGTH
static final int	TAG_SNIPPET_VALUE
static final char[]	TAG_SUMMARY
static final int	TAG_SUMMARY_LENGTH
static final int	TAG_SUMMARY_VALUE
static final char[]	TAG_SYSTEM_PROPERTY
static final int	TAG_SYSTEM_PROPERTY_LENGTH
static final int	TAG_SYSTEM_PROPERTY_VALUE
static final char[]	TAG_THROWS
static final int	TAG_THROWS_LENGTH
static final int	TAG_THROWS_VALUE
static final short	TAG_TYPE_BLOCK
static final short	TAG_TYPE_IN_SNIPPET
static final short	TAG_TYPE_INLINE
static final short	TAG_TYPE_INLINE_BLOCK
static final short	TAG_TYPE_NONE
static final char[]	TAG_USES
static final int	TAG_USES_LENGTH
static final int	TAG_USES_VALUE
static final char[]	TAG_VALUE
static final int	TAG_VALUE_LENGTH
static final int	TAG_VALUE_VALUE
static final char[]	TAG_VERSION
static final int	TAG_VERSION_LENGTH
static final int	TAG_VERSION_VALUE
static final int	THROWS_TAG_EXPECTED_ORDER

Method Summary

Static Methods

Modifier and Type	Method	Description
static char[][][]	levelTagsToChar3d(JavadocTagConstants.LevelTags[] input)	Convert an array of LevelTags into the char[][][] structure that is currently used to discover the additional tags available at a given java version.

Field Details

TAG_DEPRECATED

static final char[] TAG_DEPRECATED

TAG_PARAM

static final char[] TAG_PARAM

TAG_RETURN

static final char[] TAG_RETURN

TAG_THROWS

static final char[] TAG_THROWS

TAG_EXCEPTION

static final char[] TAG_EXCEPTION

TAG_SEE

static final char[] TAG_SEE

TAG_LINK

static final char[] TAG_LINK

TAG_LINKPLAIN

static final char[] TAG_LINKPLAIN

TAG_INHERITDOC

static final char[] TAG_INHERITDOC

TAG_VALUE

static final char[] TAG_VALUE

TAG_AUTHOR

static final char[] TAG_AUTHOR

TAG_CODE

static final char[] TAG_CODE

TAG_DOC_ROOT

static final char[] TAG_DOC_ROOT

TAG_LITERAL

static final char[] TAG_LITERAL

TAG_SERIAL

static final char[] TAG_SERIAL

TAG_SERIAL_DATA

static final char[] TAG_SERIAL_DATA

TAG_SERIAL_FIELD

static final char[] TAG_SERIAL_FIELD

TAG_SINCE

static final char[] TAG_SINCE

TAG_VERSION

static final char[] TAG_VERSION

TAG_CATEGORY

static final char[] TAG_CATEGORY

TAG_SYSTEM_PROPERTY

static final char[] TAG_SYSTEM_PROPERTY

TAG_USES

static final char[] TAG_USES

TAG_PROVIDES

static final char[] TAG_PROVIDES

TAG_HIDDEN

static final char[] TAG_HIDDEN

TAG_INDEX

static final char[] TAG_INDEX

TAG_SUMMARY

static final char[] TAG_SUMMARY

TAG_API_NOTE

static final char[] TAG_API_NOTE

TAG_IMPL_SPEC

static final char[] TAG_IMPL_SPEC

TAG_IMPL_NOTE

static final char[] TAG_IMPL_NOTE

TAG_SNIPPET

static final char[] TAG_SNIPPET

TAG_HIGHLIGHT

static final char[] TAG_HIGHLIGHT

TAG_REPLACE

static final char[] TAG_REPLACE

TAG_DEPRECATED_LENGTH

static final int TAG_DEPRECATED_LENGTH

TAG_PARAM_LENGTH

static final int TAG_PARAM_LENGTH

TAG_RETURN_LENGTH

static final int TAG_RETURN_LENGTH

TAG_THROWS_LENGTH

static final int TAG_THROWS_LENGTH

TAG_EXCEPTION_LENGTH

static final int TAG_EXCEPTION_LENGTH

TAG_SEE_LENGTH

static final int TAG_SEE_LENGTH

TAG_LINK_LENGTH

static final int TAG_LINK_LENGTH

TAG_LINKPLAIN_LENGTH

static final int TAG_LINKPLAIN_LENGTH

TAG_INHERITDOC_LENGTH

static final int TAG_INHERITDOC_LENGTH

TAG_VALUE_LENGTH

static final int TAG_VALUE_LENGTH

TAG_CATEGORY_LENGTH

static final int TAG_CATEGORY_LENGTH

TAG_AUTHOR_LENGTH

static final int TAG_AUTHOR_LENGTH

TAG_SERIAL_LENGTH

static final int TAG_SERIAL_LENGTH

TAG_SERIAL_DATA_LENGTH

static final int TAG_SERIAL_DATA_LENGTH

TAG_SERIAL_FIELD_LENGTH

static final int TAG_SERIAL_FIELD_LENGTH

TAG_SINCE_LENGTH

static final int TAG_SINCE_LENGTH

TAG_VERSION_LENGTH

static final int TAG_VERSION_LENGTH

TAG_CODE_LENGTH

static final int TAG_CODE_LENGTH

TAG_LITERAL_LENGTH

static final int TAG_LITERAL_LENGTH

TAG_DOC_ROOT_LENGTH

static final int TAG_DOC_ROOT_LENGTH

TAG_SYSTEM_PROPERTY_LENGTH

static final int TAG_SYSTEM_PROPERTY_LENGTH

TAG_USES_LENGTH

static final int TAG_USES_LENGTH

TAG_PROVIDES_LENGTH

static final int TAG_PROVIDES_LENGTH

TAG_HIDDEN_LENGTH

static final int TAG_HIDDEN_LENGTH

TAG_INDEX_LENGTH

static final int TAG_INDEX_LENGTH

TAG_SUMMARY_LENGTH

static final int TAG_SUMMARY_LENGTH

TAG_API_NOTE_LENGTH

static final int TAG_API_NOTE_LENGTH

TAG_IMPL_SPEC_LENGTH

static final int TAG_IMPL_SPEC_LENGTH

TAG_IMPL_NOTE_LENGTH

static final int TAG_IMPL_NOTE_LENGTH

TAG_SNIPPET_LENGTH

static final int TAG_SNIPPET_LENGTH

TAG_HIGHLIGHT_LENGTH

static final int TAG_HIGHLIGHT_LENGTH

TAG_REPLACE_LENGTH

static final int TAG_REPLACE_LENGTH

NO_TAG_VALUE

static final int NO_TAG_VALUE

See Also:

• Constant Field Values

TAG_DEPRECATED_VALUE

static final int TAG_DEPRECATED_VALUE

See Also:

• Constant Field Values

TAG_PARAM_VALUE

static final int TAG_PARAM_VALUE

See Also:

• Constant Field Values

TAG_RETURN_VALUE

static final int TAG_RETURN_VALUE

See Also:

• Constant Field Values

TAG_THROWS_VALUE

static final int TAG_THROWS_VALUE

See Also:

• Constant Field Values

TAG_EXCEPTION_VALUE

static final int TAG_EXCEPTION_VALUE

See Also:

• Constant Field Values

TAG_SEE_VALUE

static final int TAG_SEE_VALUE

See Also:

• Constant Field Values

TAG_LINK_VALUE

static final int TAG_LINK_VALUE

See Also:

• Constant Field Values

TAG_LINKPLAIN_VALUE

static final int TAG_LINKPLAIN_VALUE

See Also:

• Constant Field Values

TAG_INHERITDOC_VALUE

static final int TAG_INHERITDOC_VALUE

See Also:

• Constant Field Values

TAG_VALUE_VALUE

static final int TAG_VALUE_VALUE

See Also:

• Constant Field Values

TAG_CATEGORY_VALUE

static final int TAG_CATEGORY_VALUE

See Also:

• Constant Field Values

TAG_AUTHOR_VALUE

static final int TAG_AUTHOR_VALUE

See Also:

• Constant Field Values

TAG_SERIAL_VALUE

static final int TAG_SERIAL_VALUE

See Also:

• Constant Field Values

TAG_SERIAL_DATA_VALUE

static final int TAG_SERIAL_DATA_VALUE

See Also:

• Constant Field Values

TAG_SERIAL_FIELD_VALUE

static final int TAG_SERIAL_FIELD_VALUE

See Also:

• Constant Field Values

TAG_SINCE_VALUE

static final int TAG_SINCE_VALUE

See Also:

• Constant Field Values

TAG_VERSION_VALUE

static final int TAG_VERSION_VALUE

See Also:

• Constant Field Values

TAG_CODE_VALUE

static final int TAG_CODE_VALUE

See Also:

• Constant Field Values

TAG_LITERAL_VALUE

static final int TAG_LITERAL_VALUE

See Also:

• Constant Field Values

TAG_DOC_ROOT_VALUE

static final int TAG_DOC_ROOT_VALUE

See Also:

• Constant Field Values

TAG_SYSTEM_PROPERTY_VALUE

static final int TAG_SYSTEM_PROPERTY_VALUE

See Also:

• Constant Field Values

TAG_USES_VALUE

static final int TAG_USES_VALUE

See Also:

• Constant Field Values

TAG_PROVIDES_VALUE

static final int TAG_PROVIDES_VALUE

See Also:

• Constant Field Values

TAG_HIDDEN_VALUE

static final int TAG_HIDDEN_VALUE

See Also:

• Constant Field Values

TAG_INDEX_VALUE

static final int TAG_INDEX_VALUE

See Also:

• Constant Field Values

TAG_SUMMARY_VALUE

static final int TAG_SUMMARY_VALUE

See Also:

• Constant Field Values

TAG_API_NOTE_VALUE

static final int TAG_API_NOTE_VALUE

See Also:

• Constant Field Values

TAG_IMPL_SPEC_VALUE

static final int TAG_IMPL_SPEC_VALUE

See Also:

• Constant Field Values

TAG_IMPL_NOTE_VALUE

static final int TAG_IMPL_NOTE_VALUE

See Also:

• Constant Field Values

TAG_SNIPPET_VALUE

static final int TAG_SNIPPET_VALUE

See Also:

• Constant Field Values

TAG_HIGHLIGHT_VALUE

static final int TAG_HIGHLIGHT_VALUE

See Also:

• Constant Field Values

TAG_REPLACE_VALUE

static final int TAG_REPLACE_VALUE

See Also:

• Constant Field Values

TAG_OTHERS_VALUE

static final int TAG_OTHERS_VALUE

See Also:

• Constant Field Values

TAG_NAMES

static final char[][] TAG_NAMES

ORDERED_TAGS_NUMBER

static final int ORDERED_TAGS_NUMBER

See Also:

• Constant Field Values

PARAM_TAG_EXPECTED_ORDER

static final int PARAM_TAG_EXPECTED_ORDER

See Also:

• Constant Field Values

THROWS_TAG_EXPECTED_ORDER

static final int THROWS_TAG_EXPECTED_ORDER

See Also:

• Constant Field Values

SEE_TAG_EXPECTED_ORDER

static final int SEE_TAG_EXPECTED_ORDER

See Also:

• Constant Field Values

BLOCK_IDX

static final int BLOCK_IDX

See Also:

• Constant Field Values

INLINE_IDX

static final int INLINE_IDX

See Also:

• Constant Field Values

SNIPPET_IDX

static final int SNIPPET_IDX

See Also:

• Constant Field Values

HREF_TAG

static final char[] HREF_TAG

BLOCK_TAGS_RAW

static final JavadocTagConstants.LevelTags[] BLOCK_TAGS_RAW

BLOCK_TAGS

static final char[][][] BLOCK_TAGS

INLINE_TAGS_RAW

static final JavadocTagConstants.LevelTags[] INLINE_TAGS_RAW

INLINE_TAGS

static final char[][][] INLINE_TAGS

IN_SNIPPET_TAGS

static final char[][][] IN_SNIPPET_TAGS

IN_SNIPPET_TAGS_LENGTH

static final int IN_SNIPPET_TAGS_LENGTH

INLINE_TAGS_LENGTH

static final int INLINE_TAGS_LENGTH

SNIPPET_TAGS_LENGTH

static final int SNIPPET_TAGS_LENGTH

BLOCK_TAGS_LENGTH

static final int BLOCK_TAGS_LENGTH

ALL_TAGS_LENGTH

static final int ALL_TAGS_LENGTH

TAG_TYPE_NONE

static final short TAG_TYPE_NONE

See Also:

• Constant Field Values

TAG_TYPE_INLINE

static final short TAG_TYPE_INLINE

See Also:

• Constant Field Values

TAG_TYPE_BLOCK

static final short TAG_TYPE_BLOCK

See Also:

• Constant Field Values

TAG_TYPE_IN_SNIPPET

static final short TAG_TYPE_IN_SNIPPET

See Also:

• Constant Field Values

TAG_TYPE_INLINE_BLOCK

static final short TAG_TYPE_INLINE_BLOCK

See Also:

• Constant Field Values

JAVADOC_TAG_TYPE

static final short[] JAVADOC_TAG_TYPE

JAVADOC_TAG_TYPE_16PLUS

static final short[] JAVADOC_TAG_TYPE_16PLUS

PACKAGE_TAGS

static final char[][] PACKAGE_TAGS

COMPILATION_UNIT_TAGS

static final char[][] COMPILATION_UNIT_TAGS

CLASS_TAGS

static final char[][] CLASS_TAGS

FIELD_TAGS

static final char[][] FIELD_TAGS

METHOD_TAGS

static final char[][] METHOD_TAGS

MODULE_TAGS

static final char[][] MODULE_TAGS

Method Details

levelTagsToChar3d

static char[][][] levelTagsToChar3d(JavadocTagConstants.LevelTags[] input)

Convert an array of LevelTags into the char[][][] structure that is currently used to discover the additional tags available at a given java version.

Parameters:

input - A LevelTags array representing additional tags available for each java version

Returns:

a char[][][] array representing newly available tags for all java class version