モジュール jdk.compiler
パッケージ com.sun.source.doctree

インタフェースDocCommentTree

すべてのスーパー・インタフェース:
DocTree
public interface DocCommentTree
extends DocTree
ドキュメンテーション・コメントの最上位レベル表現です。

first-sentence body block-tags

導入されたバージョン:
1.8

  • ネストされたクラスのサマリー

    インタフェース com.sun.source.doctree.DocTreeで宣言されたネストされたクラス/インタフェース

    DocTree.Kind

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    List<? extends DocTree> getBlockTags()
    ドキュメント・コメントのブロック・タグを返します。
    List<? extends DocTree> getBody()
    ドキュメントのコメントの本文を返します。最初の文の後に、そしてブロック・タグの前に現れます。
    List<? extends DocTree> getFirstSentence()
    ドキュメント・コメントの最初の文を返します。
    default List<? extends DocTree> getFullBody()
    最初の文を含むブロック・タグの前に出現するドキュメンテーション・コメントの本文全体を返します。
    default List<? extends DocTree> getPostamble()
    ドキュメンテーション・コメントの内容に従って、内容(もしあれば)を含むツリーのリストを返します。
    default List<? extends DocTree> getPreamble()
    ドキュメント・コメントの内容に先行するコンテンツ(もしあれば)を含むツリーのリストを返します。

    インタフェース com.sun.source.doctree.DocTreeで宣言されたメソッド

    accept, getKind

  • メソッドの詳細

    • getFirstSentence

      List<? extends DocTree> getFirstSentence()
      ドキュメント・コメントの最初の文を返します。
      戻り値:
      ドキュメント・コメントの最初の文

    • getFullBody

      default List<? extends DocTree> getFullBody()
      最初の文を含むブロック・タグの前に出現するドキュメンテーション・コメントの本文全体を返します。
      戻り値:
      文書コメントの最初の文章の本文
      導入されたバージョン:
      9

    • getBody

      List<? extends DocTree> getBody()
      ドキュメントのコメントの本文を返します。最初の文の後に、そしてブロック・タグの前に現れます。
      戻り値:
      ドキュメンテーション・コメントの本文

    • getBlockTags

      List<? extends DocTree> getBlockTags()
      ドキュメント・コメントのブロック・タグを返します。
      戻り値:
      ドキュメンテーション・コメントのブロック・タグ

    • getPreamble

      default List<? extends DocTree> getPreamble()
      ドキュメント・コメントの内容に先行するコンテンツ(もしあれば)を含むツリーのリストを返します。 DocCommentTreeがJavaソース・ファイル内のドキュメンテーション・コメントから読み込まれると、リストは空になります。 DocCommentTreeがHTMLファイルから読み取られた場合、これはファイルの先頭から<body>タグまでのコンテンツを表します。
      実装要件:
      この実装は、空のリストを返します。
      戻り値:
      木のリスト
      導入されたバージョン:
      10

    • getPostamble

      default List<? extends DocTree> getPostamble()
      ドキュメンテーション・コメントの内容に従って、内容(もしあれば)を含むツリーのリストを返します。 DocCommentTreeがJavaソース・ファイル内のドキュメンテーション・コメントから読み込まれると、リストは空になります。 DocCommentTreeがHTMLファイルから読み取られた場合、これは</body>タグからファイルの最後までの内容を表します。
      実装要件:
      この実装は、空のリストを返します。
      戻り値:
      木のリスト
      導入されたバージョン:
      10