Javadoc 生成

Javadoc ウィザードを開くJavadoc 生成ウィザードで Javadoc を生成できます。このウィザードは、Java JDK で使用できる javadoc.exe ツールのユーザー・インターフェースです。 Javadoc ツールの詳細な資料については、「Sun's Javadoc Tool」ページにアクセスしてください。

先頭ページ

型の選択

オプション

説明

Javadoc が生成される型の選択

このリストでは、ボックスにチェックを入れるか、またはチェックをはずして、JAR ファイルにエクスポートする型を正確に指定します。このリストは、ワークベンチでの選択部分によって初期化されます。 Javadoc ツールを実行するときに 一度に使用できるプロジェクトのクラスパスは 1 つのみであるため、一度に 1 つのプロジェクトしか選択できません。

次の可視性を持つメンバーに Javadoc を作成

  • プライベート: すべてのメンバーが文書化されます。
  • パッケージ: デフォルト、プロテクト、またはパブリックの可視性のあるメンバーのみが文書化されます。
  • プロテクト: プロテクトまたはパブリックの可視性のあるメンバーのみが文書化されます。
  • パブリック: パブリック可視性のあるメンバーのみが文書化されます (デフォルト)。


標準ドックレットを使用

Javadoc コマンドを標準ドックレットで開始します (デフォルト)。 

  • 宛先: 標準ドックレットが、生成されたドキュメンテーションを書き込む宛先を選択します。この宛先はドックレット特有の引数であるため、カスタム・ドックレットを使用するときは使用不可です。


カスタム・ドックレットを使用

カスタム・ドックレットを使用してドキュメンテーションを生成します。 

  • ドックレット名: ドックレットの修飾型名。
  • ドックレット・クラスパス: ドックレット・クラスが必要とするクラスパス。


標準ドックレット引数

標準 Doclet 引数 (「標準ドックレットを使用」が選択されているときに使用可能)

オプション

説明

文書タイトル

文書タイトルを指定します。
使用ページの生成 このオプションは、ドキュメンテーションに使用ページを組み込みたい場合に選択します。
階層ツリーの生成 このオプションは、ドキュメンテーションにツリー・ページを組み込みたい場合に選択します。

ナビゲーター・バーの生成

このオプションは、ドキュメンテーションにナビゲーション・バー (ヘッダーおよびフッター) を組み込みたい場合に選択します。
索引の生成 このオプションは、ドキュメンテーションに索引ページを組み込みたい場合に選択します。
索引を文字ごとに生成 (Generate index per letter) 索引を文字ごとに作成します。「索引の生成」が選択されているときに使用可能になります。 
@作成者 このオプションは、@author タグを文書化したい場合に選択します。
@バージョン このオプションは、@version タグを文書化したい場合に選択します。
@使用すべきではない このオプションは、@deprecated タグを文書化したい場合に選択します。
使用すべきでないリスト このオプションは、ドキュメンテーションに「使用すべきでない」ページを組み込みたい場合に選択します。「@使用すべきではない」オプションが選択されているときに使用可能になります。 
Javadoc がリンクを作成する参照クラスを選択してください 他の型が参照されるときに、他のどのドキュメンテーションへのリンクを Javadoc が作成するのかを指定します。 
  • すべて選択: 他のすべてのドキュメンテーション・ロケーションへのリンクを作成します。
  • すべてクリア: 他のドキュメンテーション・ロケーションへのリンクを作成しません。
  • 構成: 参照される JAR またはプロジェクトの Javadoc ロケーションを構成します。
スタイル・シート 使用するスタイル・シートを選択します。

一般的な引数

一般的な Javadoc オプション

オプション

説明

概説

Javadoc が概説ドキュメンテーションのテキストを指定のファイルから検索することを指定します。このテキストは overview-summary.html にあります。

追加の Javadoc オプション

ここで任意の数の次の追加オプションを追加します: カスタム・ドックレット・オプション、VM オプション、または JRE 1.4 互換オプション。
スペースを含む引数は引用符で囲む必要があることに注意してください。 html コード (-header など) 指定する引数の場合、スペースおよび引用符を避けるために   または " を使用してください。

この Javadoc エクスポートの設定を Ant スクリプトとして保管

指定の Javadoc エクスポートをウィザードを使用せずに実行する Ant スクリプトの保管を指定します。既存の Ant スクリプトは、このウィザードを使用して変更できます (生成された Ant スクリプトのコンテキスト・メニューから「Javadoc ウィザードを開く」を使用)。

生成された索引ファイルをブラウザーで開く 生成された index.html ファイルをブラウザーで開きます (標準ドックレットを使用するときにのみ使用可能)。

終了」を押して Javadoc 生成を開始します。宛先がプロジェクトの「Javadoc ロケーション」ページで構成されたロケーションと異なる場合、プロジェクトの Javadoc ロケーションを新しい宛先フォルダーに設定するかどうかを尋ねられます。これを行うことによって、「外部 Javadoc を開く」を呼び出したときに、ここで作成されたドキュメンテーションが使用されます。

新しいプロセスが開始され、バックグラウンドで生成が実行されます。生成の進行および状況を確認するには、「コンソール」ビュー (「ウィンドウ」>「ビューの表示」>「コンソール」) を開いてください。

関連タスク

Javadoc ドキュメンテーションの作成

関連参照

ファイル・アクション
Javadoc ロケーション・プロパティー