Java

Javadoc 1.3 の新機能

Javadoc に施された機能強化

このドキュメントでは、バージョン 1.2.2 から 1.3 への移行で Javadoc ツールに対して行われた変更について説明します。

新機能

{@docRoot} の追加- これは Javadoc の新しいタグで、任意のクラスページからの、生成されたドキュメント階層のルートディレクトリへのパスを表します。このタグを使用する目的は、生成されたすべてのページから単一の Web ページへのリンク作成 (生成された全ページのフッタから著作権ページまたは企業ロゴへのリンクなど) を可能にすることです。(このタグは 1.3 Beta では壊れていました) (バグ #4197510)

MIF ドックレット。 これは、FrameMaker へのインポートおよびその結果として PDF、PS、RTF、Word、WordPerfect への変換を実行する目的で、MIF の出力を生成する機能を追加します。
重要 - Java 2 SDK には MIF ドックレットは含まれていません。以下のページから個別に取得する必要があります。MIF ドックレットのダウンロードページ

バグの修正

4260169: "Overrides"、"Specified By"、および "Tags copied from" に <code> HTML タグを追加しました。

4276757: 継承される package private クラスの public メンバのドキュメントを提供するよう Javadoc を修正しました。

4214932: private フィールド/メソッドが継承されているとしてドキュメント化されていたバグを修正しました。

4216836: スーパーインタフェースからのメソッドを実装するインタフェースのメソッドに対し、"Specified by:" リンクを追加しました。

4227539: 階層ツリーをルートまで上に移動していく途中で検出されるインタフェースのリスト表示が可能になりました。インタフェースの場合、「すべてのスーパーインタフェース: A、B、C (All Superinterfaces: A, B, C)」が追加されます。クラスの場合、「すべての実装インタフェース: A、B、C (All Implemented Interfaces: A, B, C)」が追加されます。

4233601: 内部クラスの概要では、誤って例外をインタフェースとしてリストしてしまうバグが修正されました。

4216434: Javadoc の -help オプションですべてのオプションを出力しない (-helpfile、-stylesheetfile) というバグが修正されました。

4235271: バグの修正により、インタフェース内のメソッドのオーバーライドが「定義: (Specified By)」として表示されるようになりました。

4231274: 括弧で囲まれた句「同様に (also extends...)」の前に空白が抜けていたため、追加されました。

4285930: 相対パスを提供する場合に、javadoc が実行されている現在のディレクトリに対する相対パスでなく、生成先ディレクトリ (-d で提供) に対する相対パスにするように、-linkoffline の第 2 引数を変更しました。

将来の機能拡張

1.3 よりあとのリリースでは、以下の拡張が行われる可能性があります。
XML ドックレット - パッケージセットの静的プログラム情報の標準化された表現です。これにより、開発者は個別に Javadoc を実行して単一のドキュメントを段階的に構築することができるようになります。Javadoc を実行するたびに中間形式を保存し、この中間形式をマージして、正確に更新されたインデックス、ツリー、クラス階層、サブクラスリストなどを備えた完全なドキュメントを生成できるようにします。

コメントの送付先: javadoc-tool@sun.com