クラスStandardDoclet

java.lang.Object
jdk.javadoc.doclet.StandardDoclet
すべての実装されたインタフェース:
Doclet
public class StandardDoclet extends Object implements Doclet
このドックレットは、指定されたモジュール、パッケージおよびタイプに対してHTML形式のドキュメントを生成します。 これは、javadocツールで使用されるドックレットで、他のドックレットが使用されない場合は「システム・ドキュメンテーション・ツール」です。

ユーザー定義タグ

標準ドックレットでは、ドキュメント・コメント内のユーザー定義タグのカスタマイズ出力を生成するために使用できるユーザー定義tagletsがサポートされています。 標準ドックレットによって呼び出されるタグでは、次のようにTaglet.toStringから文字列を戻す必要があります:
インライン・タグ
返される文字列は「フロー・コンテンツ」か、またはドキュメントの本文に表示されるHTMLコードの有効なフラグメントである必要があります。 ドキュメント・コメントでのタグの使用方法によっては、追加の制約があります: たとえば、タグを<b>や<i>などのインライン要素内で使用できる場合は、<h3>や<p>などのブロック・タグを含む文字列がtagletによって戻されないようにする必要があります。
ブロック・タグ
返される文字列は、定義リストまたは<dl>要素のコンテンツに適している必要があります。 これは通常、一連の<dt>要素と<dd>要素のペアです。
導入されたバージョン:
9
外部仕様

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

    インタフェースDocletで宣言されたネストされたクラス/インタフェース

    Doclet.Option
    修飾子と型
    インタフェース
    説明
    static interface 
    Doclet.Option
    ドックレットで使用されるオプション名、別名、パラメータおよび説明のカプセル化。

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

    コンストラクタ
    コンストラクタ
    説明
    StandardDoclet()
    HTML形式のドキュメントの生成に使用される標準ドックレットのインスタンスを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Locale
    getLocale()
    このドックレットのロケールを返します。
    String
    getName()
    ドックレットを識別する名前を返します。
    Reporter
    getReporter()
    このドックレットのレポータを返します。
    Set<? extends Doclet.Option>
    getSupportedOptions()
    サポートされているすべてのオプションを返します。
    SourceVersion
    getSupportedSourceVersion()
    このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。
    void
    init(Locale locale, Reporter reporter)
    このドックレットを、指定されたロケールおよびエラー・レポータで初期化します。
    boolean
    run(DocletEnvironment docEnv)
    ドックレットのエントリ・ポイント。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • コンストラクタの詳細

    • StandardDoclet

      public StandardDoclet()
      HTML形式のドキュメントの生成に使用される標準ドックレットのインスタンスを作成します。

  • メソッドの詳細

    • init

      public void init(Locale locale, Reporter reporter)
      インタフェース: Docletからコピーされた説明
      このドックレットを、指定されたロケールおよびエラー・レポータで初期化します。 このロケールは、レポータおよびドックレット・コンポーネントによって使用されます。
      定義:
      インタフェースDoclet内のinit
      パラメータ:
      locale - 使用されるロケール
      reporter - 使用するレポータ

    • getName

      public String getName()
      インタフェース: Docletからコピーされた説明
      ドックレットを識別する名前を返します。 名前は、「Java言語仕様」の6.2 "名前と識別子"の項で定義されているように、空白を含まない単純な識別子です。
      定義:
      インタフェースDoclet内のgetName
      戻り値:
      ドックレットの名前

    • getSupportedOptions

      public Set<? extends Doclet.Option> getSupportedOptions()
      インタフェース: Docletからコピーされた説明
      サポートされているすべてのオプションを返します。
      定義:
      インタフェースDoclet内のgetSupportedOptions
      戻り値:
      サポートされているすべてのオプションを含むセット。何もない場合は空のセット

    • getSupportedSourceVersion

      public SourceVersion getSupportedSourceVersion()
      インタフェース: Docletからコピーされた説明
      このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。
      定義:
      インタフェースDoclet内のgetSupportedSourceVersion
      戻り値:
      このドックレットでサポートされている言語バージョン(通常は最新バージョン)

    • run

      public boolean run(DocletEnvironment docEnv)
      インタフェース: Docletからコピーされた説明
      ドックレットのエントリ・ポイント。 このメソッドの指示に従って、さらに処理が開始されます。
      定義:
      インタフェースDoclet内のrun
      パラメータ:
      docEnv - そこから本質的な情報を抽出することができる
      戻り値:
      成功した場合はtrue

    • getLocale

      public Locale getLocale()
      このドックレットのロケールを返します。
      戻り値:
      このドックレットのロケール
      導入されたバージョン:
      17
      関連項目:

    • getReporter

      public Reporter getReporter()
      このドックレットのレポータを返します。
      戻り値:
      このドックレットのレポータ
      導入されたバージョン:
      17
      関連項目: