モジュール jdk.javadoc
パッケージ com.sun.javadoc

クラスDoclet

  • @Deprecated(since="9",
            forRemoval=true)
public abstract class Doclet
extends Object
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    この例は、ドックレットの起動クラスの例として、エントリポイント・メソッドを示しています。 起動クラスは、パッケージの解説で説明されているように、com.sun.javadoc.*をインポートし、start(RootDoc)メソッドを実装しなければいけません。 ドックレットは、コマンド行オプションを取る場合、optionLengthとvalidOptionsも実装する必要があります。

    1.1以降追加された言語機能(ジェネリックスと注釈型など)をサポートするドックレットは、languageVersionを実装してこのことを示す必要があります。 この実装を行わないと、ドックレットは1.5以降追加されたドックレットAPIメソッドを呼び出すことができなくなり、ドックレットから新しい構造要素(型パラメータなど)を隠すために他の複数のメソッドの結果が変更されてしまいます。

    ドックレットを起動するには、Javadocツールのコマンド行で-docletの直後に起動クラスの完全指定名を続けて渡します。

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      Doclet()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
       

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      static LanguageVersion languageVersion()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このドックレットがサポートしているJavaプログラミング言語のバージョンを返します。
      static int optionLength​(String option)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      ドックレット追加オプションをチェックします。
      static boolean start​(RootDoc root)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      ドキュメントを生成します。
      static boolean validOptions​(String[][] options, DocErrorReporter reporter)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      オプションの引数が正しいかどうかをチェックします。

    • コンストラクタの詳細

      • Doclet

        public Doclet()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。

    • メソッドの詳細

      • start

        public static boolean start​(RootDoc root)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        ドキュメントを生成します。 このメソッドは、すべてのドックレットで必要です。
        パラメータ:
        root - メソッドにRootDocを渡します。
        戻り値:
        成功した場合は、true。

      • optionLength

        public static int optionLength​(String option)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        ドックレット追加オプションをチェックします。 指定されたオプションのコマンド行で指定しなければならない引数の数を返します。 たとえば、「-d docs」の場合は2が返されます。

        ドックレットがオプションを含む場合、このメソッドが必要です。 このメソッドがないと、Javadocは、すべてのオプションで無効なフラグ・エラーを出力します。

        パラメータ:
        option - arguementの数が返されるオプション。
        戻り値:
        オプションの名前自体を含むオプションのコマンド行での引数の数。 未知のオプションの場合は、ゼロ。 エラーが発生した場合は、負の値。

      • validOptions

        public static boolean validOptions​(String[][] options,
                                   DocErrorReporter reporter)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        オプションの引数が正しいかどうかをチェックします。

        このメソッドの使用は必須ではありませんが、推奨されています。このメソッドがない場合は、すべてのオプションが有効とみなされます。 使用しない場合は、デフォルト値(true)が返されます。

        表示オプション関連のエラー・メッセージ(提供されているDocErrorReporterを使用)は、このメソッドの責任です。

        パラメータ:
        options - 有効なオプションを文字列の配列として指定します。
        reporter - これらのオプションを担当するDocErrorReporter。
        戻り値:
        オプションが有効な場合は、true。

      • languageVersion

        public static LanguageVersion languageVersion()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このドックレットがサポートしているJavaプログラミング言語のバージョンを返します。

        このメソッドは、1.1以降の言語バージョンをサポートしているドックレットで必要です。

        戻り値:
        このドックレットがサポートしている言語バージョン。
        導入されたバージョン:
        1.5