public class Javadoc extends Comment
Javadoc: /** { TagElement } */
Modifier and Type | Field and Description |
---|---|
static SimplePropertyDescriptor |
COMMENT_PROPERTY
Deprecated.
Replaced by
TAGS_PROPERTY in the JLS3 API. |
static ChildListPropertyDescriptor |
TAGS_PROPERTY
The "tags" structural property of this node type (element type:
TagElement ). |
ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CREATION_REFERENCE, DIMENSION, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, LABELED_STATEMENT, LAMBDA_EXPRESSION, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, MODULE_DECLARATION, MODULE_MODIFIER, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, REQUIRES_DIRECTIVE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SUPER_METHOD_REFERENCE, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, UNION_TYPE, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE
Modifier and Type | Method and Description |
---|---|
String |
getComment()
Deprecated.
The comment string was replaced in the 3.0 release
by a representation of the structure of the doc comment.
See
tags . |
static List |
propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type.
|
void |
setComment(String docComment)
Deprecated.
The comment string was replaced in the 3.0 release
by a representation of the structure of the doc comment.
See
tags . |
List |
tags()
Returns the live list of tag elements that make up this doc
comment.
|
getAlternateRoot, isBlockComment, isDocComment, isLineComment, setAlternateRoot
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString
public static final SimplePropertyDescriptor COMMENT_PROPERTY
TAGS_PROPERTY
in the JLS3 API.String
) (JLS2 API only).public static final ChildListPropertyDescriptor TAGS_PROPERTY
TagElement
).public static List propertyDescriptors(int apiLevel)
apiLevel
- the API level; one of the
AST.JLS*
constantsStructuralPropertyDescriptor
)public String getComment()
tags
.UnsupportedOperationException
- if this operation is used in
an AST later than JLS2public void setComment(String docComment)
tags
.docComment
- the doc comment stringIllegalArgumentException
- if the Java comment string is invalidUnsupportedOperationException
- if this operation is used in
an AST later than JLS2public List tags()
The tag elements cover everything except the starting and ending
comment delimiters, and generally omit leading whitespace
(including a leading "*") and embedded line breaks.
The first tag element of a typical doc comment represents
all the material before the first explicit doc tag; this
first tag element has a null
tag name and
generally contains 1 or more TextElement
s,
and possibly interspersed with tag elements for nested tags
like "String
".
Subsequent tag elements represent successive top-level doc
tag (e.g., "@param", "@return", "@see").
Adding and removing nodes from this list affects this node dynamically.
TagElement
)
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.