java.lang.Object
jdk.javadoc.doclet.StandardDoclet
- すべての実装されたインタフェース:
Doclet
このドックレットは、指定されたモジュール、パッケージおよびタイプに対してHTML形式のドキュメントを生成します。
ユーザー定義タグ
標準ドックレットでは、ドキュメント・コメント内のユーザー定義タグのカスタマイズ出力を生成するために使用できるユーザー定義taglets
がサポートされています。 標準ドックレットによって呼び出されるタグでは、次のようにTaglet.toString
から文字列を戻す必要があります:
- インライン・タグ
- 返される文字列は「フロー・コンテンツ」か、またはドキュメントの本文に表示されるHTMLコードの有効なフラグメントである必要があります。 ドキュメント・コメントでのタグの使用方法によっては、追加の制約があります: たとえば、タグを
<b>
や<i>
などのインライン要素内で使用できる場合は、<h3>
や<p>
などのブロック・タグを含む文字列がtagletによって戻されないようにする必要があります。 - ブロック・タグ
- 返される文字列は、定義リストまたは
<dl>
要素のコンテンツに適している必要があります。 これは通常、一連の<dt>
要素と<dd>
要素のペアです。
- 外部仕様
-
ネストされたクラスのサマリー
インタフェースjdk.javadoc.doclet.Docletで宣言されたネストされたクラス/インタフェース
Doclet.Option
-
コンストラクタのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明このドックレットのロケールを返します。getName()
ドックレットを識別する名前を返します。このドックレットのレポータを返します。Set
<? extends Doclet.Option> サポートされているすべてのオプションを返します。このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。void
このドックレットを、指定されたロケールおよびエラー・レポータで初期化します。boolean
run
(DocletEnvironment docEnv) ドックレットのエントリ・ポイント。
-
コンストラクタの詳細
-
StandardDoclet
public StandardDoclet()HTML形式のドキュメントの生成に使用される標準ドックレットのインスタンスを作成します。
-
-
メソッドの詳細
-
init
インタフェース:Doclet
からコピーされた説明このドックレットを、指定されたロケールおよびエラー・レポータで初期化します。 このロケールは、レポータおよびドックレット・コンポーネントによって使用されます。 -
getName
public String getName()インタフェース:Doclet
からコピーされた説明ドックレットを識別する名前を返します。 名前は、「Java言語仕様」の6.2 "名前と識別子"の項で定義されているように、空白を含まない単純な識別子です。 -
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
からコピーされた説明ドックレットのエントリ・ポイント。 このメソッドの指示に従って、さらに処理が開始されます。 -
getLocale
public Locale getLocale()このドックレットのロケールを返します。- 戻り値:
- このドックレットのロケール
- 導入されたバージョン:
- 17
- 関連項目:
-
getReporter
public Reporter getReporter()このドックレットのレポータを返します。- 戻り値:
- このドックレットのレポータ
- 導入されたバージョン:
- 17
- 関連項目:
-