DocTree
public interface DocCommentTree extends DocTree
first-sentence body block-tags
DocTree.Kind
Modifier and Type | Method | Description |
---|---|---|
List |
getBlockTags() |
Returns the block tags for a documentation comment. |
List |
getBody() |
Returns the body of a documentation comment, appearing after the first sentence, and before any block tags. |
List |
getFirstSentence() |
Returns the first sentence of a documentation comment. |
default List |
getFullBody() |
Returns the entire body of a documentation comment, appearing before any block tags, including the first sentence. |
default List |
getPostamble() |
Returns a list of trees containing the content (if any) following the content of the documentation comment. |
default List |
getPreamble() |
Returns a list of trees containing the content (if any) preceding the content of the documentation comment. |
List<? extends DocTree> getFirstSentence()
default List<? extends DocTree> getFullBody()
List<? extends DocTree> getBody()
List<? extends DocTree> getBlockTags()
default List<? extends DocTree> getPreamble()
DocCommentTree
has been read from a documentation comment in a Java source file, the list will be empty. When the DocCommentTree
has been read from an HTML file, this represents the content from the beginning of the file up to and including the <body>
tag.default List<? extends DocTree> getPostamble()
DocCommentTree
has been read from a documentation comment in a Java source file, the list will be empty. When DocCommentTree
has been read from an HTML file, this represents the content from the </body>
tag to the end of file.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.compiler/com/sun/source/doctree/DocCommentTree.html