|
標準ドックレット
|
目次
標準ドックレットの概要
標準ドックレットは、Sun が提供するドックレットで、Javadoc のデフォルトの HTML 形式による API 出力を生成します。この JDKTM ドキュメントに含まれる JavaTM プラットフォームの API ドキュメントは、標準ドックレットによる出力の例です。Javadoc の -doclet オプションを使ってコマンド行にほかのドックレットが指定されていない場合、標準ドックレットが使われます。
標準ドックレットで生成される API ドキュメントは、JDK 1.1 ソフトウェアの Javadoc ツールが生成する形式と異なります。標準ドックレットの出力は、JDK 1.2 ソフトウェアのベータ版の開発期間中にも変更されています。これらの変更点についての概要、およびソースコードでドキュメンテーションコメントを記述する際の新しい仕様については、「Javadoc 1.2 の新機能」を参照してください。
標準ドックレットの内容は、ドックレット API を使う時のよい参考になります。また、標準ドックレットからデフォルトの HTML 出力がどのように生成されるかを見ることで、標準ドックレットを修正してカスタム API ドキュメントを生成する独自のドックレットを作成する作業が容易になります。
標準ドックレットのクラス
標準ドックレットは、com.sun.tools.doclets パッケージと com.sun.tools.doclets.standard パッケージのクラスで構成されています。これらのパッケージは、Java プラットフォームのコア API の一部ではありません。次は、デフォルトの HTML 出力の生成で重要な役割を果たす標準ドックレットのクラスです。
- Standard - このクラスには start メソッドが含まれており、標準ドックレットのエントリポイントになります。javadoc が扱うパッケージやクラスの HTML API ファイルの生成を組織化します。
- HtmlWriter - HTML 形式の出力を生成するために必要な各種 HTML タグを記述する API を含むクラスです。
- HtmlDocWriter - HtmlWriter クラスを継承するクラスで、デフォルトの HTML 出力で使われる特殊なハイパーリンクの生成に関する HTML 関連 API が追加されています。HTML ページのヘッダとフッタの中のリンクを含みます。
- PackageIndexWriter - javadoc のコマンド行で指定されている全パッケージのリストを含む overview-summary.html ファイルを生成します。生成されるファイルのサンプルは、この Java Development Kit の API ドキュメントにある overview-summary.html ファイルを参照してください。
- PackageIndexFrameWriter - overview-frame.html ファイルを生成します。このファイルは、フレーム形式のデフォルト出力の左上のフレームにパッケージリンクのリストを表示するために使われます。この JDK ドキュメントの API ドキュメントにある overview-frame.html ファイルを参照してください。
- PackageFrameWriter - package-frame.html ファイルを生成します。このファイルは、フレーム形式のデフォルト出力の左下のフレームに、特定のパッケージのインタフェースとクラスのリストを表示するために使われます。この種のページの例としては、この JDK ドキュメントの API ドキュメントに含まれる java.awt の package-frame.html ファイルを参照してください。
- FrameOutputWriter - index.html ファイルを生成します。このファイルは、API ドキュメントのフレーム形式の「カバーページ」を表示するために使われます。例としては、JDK ドキュメントの index.html ファイルを参照してください。
- PackageWriter - package-summary.html ファイルを生成します。このファイルでは、特定のパッケージのインタフェースとクラスのリストが表示されます。例としては、この API ドキュメントの java.lang の package-summary.html ページを参照してください。
- ClassWriter - 個々のインタフェースとクラスに対する HTML 形式の API ドキュメントを生成します。例としては、JDK の API ドキュメントの Font.html ファイルを参照してください。
-splitindex オプションが使われていないときに標準ドックレットが作成するクラスメンバに対して、単一のインデックスファイルを生成します。
- SplitIndexWriter - Javadoc がコマンド行オプション -breakindex を指定して標準ドックレットを実行したときに作成されるクラスメンバに対して、複数のインデックスファイルを生成します。生成されるファイルは index-1.html です。
- TreeWriter - overview-tree.html ファイルを生成します。このファイルでは、標準ドックレットが扱うクラスのクラス階層が一覧表示されます。例としては、JDK の API ドキュメントの overview-tree.html ファイルを参照してください。
- DeprecatedListWriter - deprecatedlist.html ファイルを生成します。このファイルでは、推奨されない API が一覧表示されます。例としては、API ドキュメントの deprecated-list.html ファイルを参照してください。
- ClassUseMapper、
ClassUseWriter および
PackageUseWriter -
これらのクラスは、クラスおよびパッケージの Use ファイルを生成します。ナビゲーションバーの [使用] リンクをクリックすると、クラスまたはパッケージの [使用] ページに進みます。たとえば、Character クラスおよび java.lang パッケージには、そのようなページがあります。
- PackageListWriter
- API ドキュメントの最上位ディレクトリに置かれる package-list テキストファイルを生成します。このファイルは、標準ドックレットの -link コマンド行オプションで使用します。標準ドックレットの Extern クラスも、-link オプションの作成に関して、このファイルと同じ役割を持ちます。このオプションの詳細については、Javadoc リファレンスページ ([Windows] [Solaris]) を参照してください。
- Group - このクラスは、パッケージのグループを overview-summary.html ページの 1 つ以上の表にまとめます。このクラスは、標準ドックレットの -group コマンド行オプションをサポートしています。このオプションの詳細については、Javadoc リファレンスページ ([Windows] [Solaris]) を参照してください。
標準ドックレットの実行
ほかのドックレットを指定する -doclet タグがコマンド行にない場合、デフォルトで標準ドックレットが呼び出されます。
% javadoc MyPackage
上のコマンドを実行すると、標準ドックレットを使って、MyPackage についての HTML 形式の API ドキュメントが、デフォルトのスタイルで生成されます。-doclet オプションを指定しないで javadoc を実行した場合は、-doclet オプションを指定して標準ドックレットを呼び出した場合と同じ処理が行われます。
% javadoc MyClass.java
このコマンドを実行すると、次のコマンドを実行した場合と同じ処理が行われます。
% javadoc -doclet com.sun.tools.doclets.standard.Standard MyClass.java
標準ドックレットのソース
JDK ドキュメントをダウンロードしてインストールした場合、標準ドックレットのソースファイルはディレクトリ docs/tooldocs/javadoc/source と docs/tooldocs/javadoc/source/standard に格納されます。次のリンクを使うと、ソースコードを表示できます。
