Skip navigation links
javax.ide.model.java.source.tree
Interface DocCommentT
- All Superinterfaces:
- HasNameT, Tree
-
public interface DocCommentT
- extends Tree, HasNameT
A doc comment (short for "documentation comment"). Corresponds to com.sun.javadoc.Doc in the Doclet API.
Fields inherited from interface javax.ide.model.java.source.tree.Tree |
EMPTY_ARRAY |
Method Summary |
java.lang.String |
getCommentText()
Gets the processed comment text for this doc element, commonly called the "description", using '\n' line terminators. |
Tree |
getOwningDeclaration()
Gets the declaration this doc element is associated with, null if none. |
java.lang.String |
getRawCommentText()
Gets the unprocessed comment text for this doc element, using '\n' line terminators. |
Methods inherited from interface javax.ide.model.java.source.tree.Tree |
accept, addSelf, addSelf, addSelfAfter, addSelfBefore, clearProperty, cloneSelf, getChildren, getOwningFile, getParent, getPosition, getProperty, getSiblingAfter, getSiblingBefore, getSiblings, getTreeKind, isSynthetic, removeSelf, replaceSelf, setProperty |
getOwningDeclaration
Tree getOwningDeclaration()
- Gets the declaration this doc element is associated with, null if none. For example, if this doc element is associated with a method declaration, this will return that method declaration.
-
- Returns:
- The associated declaration element, null if none.
getCommentText
java.lang.String getCommentText()
- Gets the processed comment text for this doc element, commonly called the "description", using '\n' line terminators.
-
- Returns:
- The processed text for this comment.
getRawCommentText
java.lang.String getRawCommentText()
- Gets the unprocessed comment text for this doc element, using '\n' line terminators.
-
- Returns:
- The unprocessed text for this comment.
Skip navigation links
Copyright © 1997, 2013, Oracle. All rights reserved.