Module jdk.compiler

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
    • Method Detail

      • 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