外部 Javadoc 実行は、デフォルトの実行方法です。実行方法として、内部 Javadoc ではなく外部 Javadoc を使用することで、大量のコード (JDK など) のドキュメントを生成した場合でも、メモリー不足によるエラーの発生が低くなります。
「プロジェクト設定」ウィンドウの「Javadoc 実行方法」ノードでは、メモリー容量の設定などの、外部 Javadoc の設定を行えます。プロパティの値を変更した場合、変更結果はその実行方法を使用する全クラスに適用されます。以下に、外部 Javadoc のプロパティについて説明します。
「プロパティ」タブ |
1.1 形式 |
「True」の場合は、Javadoc 1.1 で生成されるドキュメントと同じ形式と機能を持つドキュメントを生成します。ページの背景はグレーで、ヘッダーに画像を使用し、表ではなく箇条書きを使用し、フラットな出力先ディレクトリ構造を持ちます。これらのページは継承 API は含んでおらず、HTML フレームを使用せず、内部クラスをサポートしません。さらに、このプロパティはアルファベット 1 文字ごとに索引ファイルを分割します。
|
doclet |
ドキュメントの生成に使用する doclet を指定します。doclet は、ページの内容を定義して出力を書式設定します。デフォルトでは、外部 Javadoc は標準 doclet を使用して HTML ページを生成します。
|
エンコーディング |
EUCJIS/SJIS といった、ソースファイルのエンコーディング名を指定します。
|
Extdirs |
拡張クラスが常駐するディレクトリを指定します。これらのクラスでは、Java 拡張メカニズムを使用します。extdirs は、ソースファイルとクラスファイルの検索に Javadoc が使用するファイルシステムの一部です。
|
ロケール |
ドキュメントを生成するときに Javadoc が使用するロケールを指定します (en_US (英語、米国) など)。
|
メンバー |
生成するドキュメントに含めるメンバーを指定します。選択肢は、protected、public、package、private です。protected の場合は、protected および public のクラスとメンバーが表示されます。これがデフォルト値です。public の場合は、public クラスと public メンバーが表示されます。package の場合は、package、protected、public のクラスとメンバーが表示されます。private の場合は、すべてのクラスとメンバーが表示されます。
|
概要 |
概要ドキュメントのテキストとして Javadoc が検索するファイルを指定します。このファイルは通常 overview.html であり、ソースツリーのトップレベルに位置しています。
|
再帰的 |
「True」の場合は、ディレクトリを再帰的に作成します。
|
詳細 |
「True」の場合は、Javadoc の生成中に詳細メッセージを出力します。
|