モジュール jdk.javadoc
パッケージ jdk.javadoc.doclet

クラスStandardDoclet

java.lang.Object
jdk.javadoc.doclet.StandardDoclet
すべての実装されたインタフェース:
Doclet
public class StandardDoclet
extends Object
implements Doclet
このドックレットは、指定されたモジュール、パッケージ、および型のHTML形式のドキュメントを生成します。

ユーザー定義タグ

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

  • コンストラクタの詳細

  • メソッドの詳細

    • getSupportedOptions

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