W3cubDocs

/OpenJDK 21

Interface DocCommentTree

All Superinterfaces:
DocTree
public interface DocCommentTree extends DocTree
The top-level representation of a documentation comment. 
    first-sentence body block-tags
Since:
1.8

Nested Class Summary

Nested classes/interfaces declared in interface com.sun.source.doctree.DocTree

DocTree.Kind

Method Summary

Modifier and Type Method Description
List<? extends DocTree> getBlockTags()
Returns the block tags for a documentation comment.
List<? extends DocTree> getBody()
Returns the body of a documentation comment, appearing after the first sentence, and before any block tags.
List<? extends DocTree> getFirstSentence()
Returns the first sentence of a documentation comment.
default List<? extends DocTree> getFullBody()
Returns the entire body of a documentation comment, appearing before any block tags, including the first sentence.
default List<? extends DocTree> getPostamble()
Returns a list of trees containing the content (if any) following the content of the documentation comment.
default List<? extends DocTree> getPreamble()
Returns a list of trees containing the content (if any) preceding the content of the documentation comment.

Methods declared in interface com.sun.source.doctree.DocTree

accept, getKind

Method Details

getFirstSentence

List<? extends DocTree> getFirstSentence()
Returns the first sentence of a documentation comment.
Returns:
the first sentence of a documentation comment

getFullBody

default List<? extends DocTree> getFullBody()
Returns the entire body of a documentation comment, appearing before any block tags, including the first sentence.
Returns:
body of a documentation comment first sentence inclusive
Since:
9

getBody

List<? extends DocTree> getBody()
Returns the body of a documentation comment, appearing after the first sentence, and before any block tags.
Returns:
the body of a documentation comment

getBlockTags

List<? extends DocTree> getBlockTags()
Returns the block tags for a documentation comment.
Returns:
the block tags of a documentation comment

getPreamble

default List<? extends DocTree> getPreamble()
Returns a list of trees containing the content (if any) preceding the content of the documentation comment. When the 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.
Implementation Requirements:
This implementation returns an empty list.
Returns:
the list of trees
Since:
10

getPostamble

default List<? extends DocTree> getPostamble()
Returns a list of trees containing the content (if any) following the content of the documentation comment. When the 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.
Implementation Requirements:
This implementation returns an empty list.
Returns:
the list of trees
Since:
10

© 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