OpenJDK 27 · com.sun.source.doctree.DocCommentTree · APIdia, the JavaDoc alternative

Method Summary

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

Inherited from com.sun.source.doctree.DocTree:: accept getKind

Method Detail

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

getBlockTags

back to summary

public List<? extends DocTree> getBlockTags()

Returns the block tags for a documentation comment.

Returns:List<? extends DocTree>: the block tags of a documentation comment

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

getBody

back to summary

public List<? extends DocTree> getBody()

Returns the body of a documentation comment, appearing after the first sentence, and before any block tags.

Returns:List<? extends DocTree>: the body of a documentation comment

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

getFirstSentence

back to summary

public List<? extends DocTree> getFirstSentence()

Returns the first sentence of a documentation comment.

Returns:List<? extends DocTree>: the first sentence of a documentation comment

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

getFullBody

back to summary

public default List<? extends DocTree> getFullBody()

Returns the entire body of a documentation comment, appearing before any block tags, including the first sentence.

Returns:List<? extends DocTree>: body of a documentation comment first sentence inclusive
Since: 9

getPostamble back to summary

getPostamble	back to summary
public 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 Specification This implementation returns an empty list. Returns:List<? extends DocTree> the list of trees Since 10

public 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 Specification

This implementation returns an empty list.

Returns:List<? extends DocTree>: the list of trees
Since: 10

getPreamble back to summary

getPreamble	back to summary
public 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 Specification This implementation returns an empty list. Returns:List<? extends DocTree> the list of trees Since 10

public 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 Specification

This implementation returns an empty list.

Returns:List<? extends DocTree>: the list of trees
Since: 10

public Interface DocCommentTree

Method Summary

Method Detail