Klasse Javadoc
java.lang.Object
org.aspectj.org.eclipse.jdt.core.dom.ASTNode
org.aspectj.org.eclipse.jdt.core.dom.Comment
org.aspectj.org.eclipse.jdt.core.dom.Javadoc
AST node for a Javadoc-style doc comment.
Javadoc: /** { TagElement } */
- Seit:
- 2.0
-
Feldübersicht
Modifizierer und TypFeldBeschreibungstatic final SimplePropertyDescriptor
Veraltet.static final ChildListPropertyDescriptor
The "tags" structural property of this node type (element type:TagElement
).Von Klasse geerbte Felder org.aspectj.org.eclipse.jdt.core.dom.ASTNode
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, CASE_DEFAULT_EXPRESSION, 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, ENHANCED_FOR_WITH_RECORD_PATTERN, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, GUARDED_PATTERN, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, JAVADOC_REGION, JAVADOC_TEXT_ELEMENT, 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, MODULE_QUALIFIED_NAME, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NULL_PATTERN, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, PATTERN_INSTANCEOF_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECORD_DECLARATION, RECORD_PATTERN, 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_EXPRESSION, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TAG_PROPERTY, TEXT_BLOCK, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, TYPE_PATTERN, UNION_TYPE, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, YIELD_STATEMENT
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungVeraltet.The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment.static List
propertyDescriptors
(int apiLevel) Returns a list of structural property descriptors for this node type.void
setComment
(String docComment) Veraltet.The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment.tags()
Returns the live list of tag elements that make up this doc comment.Von Klasse geerbte Methoden org.aspectj.org.eclipse.jdt.core.dom.Comment
getAlternateRoot, isBlockComment, isDocComment, isLineComment, setAlternateRoot
Von Klasse geerbte Methoden org.aspectj.org.eclipse.jdt.core.dom.ASTNode
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
-
Felddetails
-
COMMENT_PROPERTY
Veraltet.Replaced byTAGS_PROPERTY
in the JLS3 API.The "comment" structural property of this node type (type:String
) (JLS2 API only).- Seit:
- 3.0
-
TAGS_PROPERTY
The "tags" structural property of this node type (element type:TagElement
).- Seit:
- 3.1
-
-
Methodendetails
-
propertyDescriptors
Returns a list of structural property descriptors for this node type. Clients must not modify the result.- Parameter:
apiLevel
- the API level; one of theAST.JLS*
constants- Gibt zurück:
- a list of property descriptors (element type:
StructuralPropertyDescriptor
) - Seit:
- 3.0
-
getComment
Veraltet.The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. Seetags
.Returns the doc comment string, including the starting and ending comment delimiters, and any embedded line breaks.- Gibt zurück:
- the doc comment string
- Löst aus:
UnsupportedOperationException
- if this operation is used in an AST later than JLS2
-
setComment
Veraltet.The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. Seetags
.Sets or clears the doc comment string. The documentation string must include the starting and ending comment delimiters, and any embedded line breaks.- Parameter:
docComment
- the doc comment string- Löst aus:
IllegalArgumentException
- if the Java comment string is invalidUnsupportedOperationException
- if this operation is used in an AST later than JLS2
-
tags
Returns the live list of tag elements that make up this doc comment.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 moreAbstractTextElement
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.
- Gibt zurück:
- the live list of tag elements in this doc comment
(element type:
TagElement
) - Seit:
- 3.0
-
TAGS_PROPERTY
in the JLS3 API.