|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.core.dom.ASTNode
org.eclipse.jdt.core.dom.Comment
org.eclipse.jdt.core.dom.Javadoc
AST node for a Javadoc-style doc comment.
Javadoc: /** { TagElement } */
Field Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.eclipse.jdt.core.dom.Comment |
---|
getAlternateRoot, isBlockComment, isDocComment, isLineComment, setAlternateRoot |
Methods inherited from class org.eclipse.jdt.core.dom.ASTNode |
---|
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final SimplePropertyDescriptor COMMENT_PROPERTY
TAGS_PROPERTY
in the JLS3 API.
public static final ChildListPropertyDescriptor TAGS_PROPERTY
Method Detail |
public static List propertyDescriptors(int apiLevel)
apiLevel
- the API level; one of the
AST.JLS*
constants
StructuralPropertyDescriptor
)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 string
IllegalArgumentException
- if the Java comment string is invalid
UnsupportedOperationException
- 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
)
|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |