モジュール jdk.javadoc

パッケージ jdk.javadoc.doclet

クラスStandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

すべての実装されたインタフェース:

Doclet

public class StandardDoclet
extends Object
implements Doclet

このドックレットは、指定されたモジュール、パッケージ、および型のHTML形式のドキュメントを生成します。

関連項目:

標準ドックレットのドキュメンテーション・コメント指定

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

インタフェース jdk.javadoc.doclet.Docletから継承したネストされたクラス/インタフェース

Doclet.Option

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

コンストラクタ

コンストラクタ	説明
StandardDoclet()

メソッドのサマリー

修飾子と型	メソッド	説明
String	getName()	ドックレットを識別する名前を返します。
Set<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()

メソッドの詳細

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<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