パッケージ com.sun.javadoc

ドックレット API は、javadoc の出力のカスタマイズに使用します。

参照:
説明

インタフェースの概要

ClassDoc	特定の Java クラスを表し、クラス、クラスのコメントとタグ、およびクラスのメンバに関する情報へのアクセスを提供します。
ConstructorDoc	特定の Java クラスの特定のコンストラクタを表します。
Doc	すべての Doc クラスの抽象基底クラスです。
DocErrorReporter	エラー、警告、および通知の表示機能を提供するインタフェースです。
ExecutableMemberDoc	特定の Java クラスの特定のメソッドまたはコンストラクタを表します。
FieldDoc	特定の Java クラス内の特定のフィールドを表します。
MemberDoc	特定の Java クラスの特定のメンバ (フィールド、コンストラクタ、メソッドのどれか) を表します。
MethodDoc	特定の Java クラスの特定のメソッドを表します。
PackageDoc	特定の Java パッケージを表します。
Parameter	パラメータ情報 (パラメータの型と名前) です。
ParamTag	特定のドキュメンテーションタグ @param を表します。
ProgramElementDoc	Java プログラムの特定の要素 (クラス、インタフェース、フィールド、コンストラクタ、メソッドのどれか) を表します。
RootDoc	このクラスには、javadoc の特定の実行時における情報 (特に、パッケージ、クラス、 ユーザが指定したオプションなど) が格納されます。
SeeTag	ドキュメンテーションタグ @see を表します。
SerialFieldTag	ObjectStreamField によって定義される Serializable フィールドのドキュメントを作成します。
SourcePosition	このインタフェースはソース位置を記述します。
Tag	特定のドキュメンテーションタグ (@since、@author、@version など) を表します。
ThrowsTag	特定のドキュメンテーションタグ @throws または @exception を表します。
Type	Java の型を表します。

クラスの概要

Doclet

このクラスは、ドックレットに含まれるエントリポイントメソッドのドキュメントを生成します。

パッケージ com.sun.javadoc の説明

ドックレット API は、javadoc の出力のカスタマイズに使用します。javadoc によって呼び出されたドックレットは、この API を使用してプログラムの構造情報を取得します。呼び出し方法は抽象クラスの Doclet で定義されており、エントリポイントは次のように start メソッドになっています。

    public static boolean start(RootDoc root)

RootDoc のインスタンスは、プログラムの構造情報のルートを保持しています。このルートから、ほかのすべてのプログラム構造情報を取り出すことができます。たとえば、次のドックレットは、処理対象のクラスの @param タグに含まれている情報を表示します。

import com.sun.javadoc.*;

public class ListParams extends Doclet {

    public static boolean start(RootDoc root) {
        ClassDoc[] classes = root.classes();
        for (int i = 0; i < classes.length; ++i) {
            ClassDoc cd = classes[i];
            printMembers(cd.constructors());
            printMembers(cd.methods());
        }
        return true;
    }

    static void printMembers(ExecutableMemberDoc[] mems) {
        for (int i = 0; i < mems.length; ++i) {
            ParamTag[] params = mems[i].paramTags();
            System.out.println(mems[i].qualifiedName());
            for (int j = 0; j < params.length; ++j) {
                System.out.println("   " + params[j].parameterName()
                    + " - " + params[j].parameterComment());
            }
        }
    }        
}

赤で表示されたメソッドが、javadoc API のメソッドです。javadoc API のインタフェースは緑で表示されています。Doclet は、ドックレットの呼び出しインタフェースを指定する抽象クラスです。ClassDoc には、クラス情報が保持されます。ExecutableMemberDoc は、MethodDoc と ConstructorDoc のスーパーインタフェースです。ParamTag には、@param タグから得た情報が保持されます。

コマンド行で次のように指定して、このドックレットを呼び出すと、

    javadoc -doclet ListParams -sourcepath <source-location> java.util

次の出力が得られます。

    ...
    java.util.ArrayList.add
       index - index at which the specified element is to be inserted.
       element - element to be inserted.
    java.util.ArrayList.remove
       index - the index of the element to removed.
    ...

関連項目:

Doclet, RootDoc