IDE の Javadoc モジュールは、デフォルトの標準 を使用し、出力の内容と形式を決定します。標準 doclet は、HTML 形式で API ドキュメントを生成します。
標準 doclet のプロパティを変更する手順は、次のとおりです。
作成者 (author) | 生成するドキュメントに @author テキストを入れます。 |
最下部 | 各 HTML ファイルの最下部にテキストを表示することを指定します。テキストは、ナビゲーションバーの下に表示されます。テキストには、HTML タグを含めることができます。空白文字は引用符で囲むとともに、テキスト内の引用符はエスケープする必要があります。 |
文字セット | 生成するドキュメントで使用する HTML 文字セットを指定します (iso-8859-1 など)。 |
出力先 | 生成したファイルを保存するディレクトリを指定します。デフォルトは、ユーザーディレクトリにある javadoc ディレクトリです。 |
doc タイトル | 概要ファイルの上部中央、ナビゲーションバーのすぐ下に配置されるタイトルを指定します。テキストには、 HTML タグを含めることができます。空白文字は引用符で囲むとともに、テキスト内の引用符はエスケープする必要があります。 |
フッター | 各 HTML ファイルの最下部に表示されるテキストを指定します。テキストは、ナビゲーションバーの右側に配置されます。テキストには、HTML タグを含めることができます。空白文字は引用符で囲むとともに、テキスト内の引用符はエスケープする必要があります。 |
グループ | 概要ページに表示されるパッケージを指定のグループに分類します。グループは、指定した順序でページに配置されます。 グループ内のパッケージは、アルファベット順に並べられます。 |
ヘッダー | 各 HTML ファイルの最上部に表示されるテキストを指定します。テキストは、ナビゲーションバーの右側に配置されます。テキストには、HTML タグを含めることができます。空白文字は引用符で囲むとともに、テキスト内の引用符はエスケープする必要があります。 |
ヘルプファイル |
各ページの最上部と最下部にあるナビゲーションバーの「ヘルプ」にリンクするヘルプファイルを指定します。デフォルトは help-doc.html です。
|
リンク | リンク先の既存 Javadoc ドキュメントの URL を指定します。このプロパティで、コードが参照するクラスにリンクできます。 |
非推奨なし | 「True」の場合は、非推奨 API をドキュメントに生成しません。 |
非推奨リストなし |
「True」の場合は、非推奨 API のリストが含まれるファイル deprecated-list.html 、およびナビゲーションバーにあるこのページへのリンクを生成しません (以降のドキュメントにおいても非推奨 API は生成されます)。
|
ヘルプなし | 「True」の場合は、各ページの最上部と最下部にあるナビゲーションバーに「ヘルプ」を含めません。 |
索引なし | 「True」の場合は、索引をドキュメントに含めません。 |
ナビゲーションバーなし | 「True」の場合は、生成するドキュメントにナビゲーションバー、ヘッダー、フッターを含めません。印刷を目的として PDF や PostScript にファイルを変換する場合には、このプロパティが便利です。 |
ツリーなし | 「True」の場合は、生成するドキュメントにクラスやインタフェースの階層を含めません。 |
索引を分割 | 「True」の場合は、複数のファイルに索引を分割します。ファイルは、各アルファベットにつき 1 つずつと、アルファベット以外の文字で始まる全エントリに対して 1 つ作成されます。 |
スタイルシートファイル |
HTML ページの表示方法を記述するスタイル規則 (テキストのサイズ、色、間隔など) の集合であるスタイルシートのパスを指定します。ファイルを指定しない場合は、stylesheet.css が使用されます。
|
使用 | 「True」の場合は、ドキュメント対象のクラスとパッケージそれぞれが、どこで使用されているかを表示する「使用」ページへのリンクを含めます。このページは、特定のクラスやパッケージの API を使用するパッケージ、クラス、メソッド、コンストラクタ、フィールドについて記述します。 |
バージョン | 「True」の場合は、生成するドキュメントに @version テキストを含めます。 |
ウィンドウタイトル | HTML の <title> タグに含めるテキストを指定します。このテキストは、ウィンドウタイトルとブラウザのブックマークに表示されます。タイトルテキストに HTML タグを含めることはできません。また、テキスト内の引用符はエスケープする必要があります。 |
![]() |
カスタム doclet を作成するには、「doclet」ノードをマウスの右ボタンでクリックし、「新規標準 doclet サービス」を選択します。doclet のノードが「プロジェクト設定」ウィンドウに追加されます。ノードを選択してプロパティを変更します。 |
標準 doclet のプロパティの詳細については、Sun Microsystems の Web ページ
http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html
を参照してください。
関連項目 | |
---|---|
デフォルト Javadoc 検索エンジンの指定
Javadoc のデフォルトの実行方法の指定 |