モジュール 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>要素のペアです。

導入されたバージョン:

9

外部仕様

• 標準ドックレットのドキュメンテーション・コメント仕様
• HTML Standard

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

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

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)	ドックレットのエントリ・ポイント。

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

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

関連項目:

• init(Locale, Reporter)

getReporter

public Reporter getReporter()

このドックレットのレポータを返します。

戻り値:

このドックレットのレポータ

導入されたバージョン:

17

関連項目:

• init(Locale, Reporter)