標準ドックレット

標準ドックレットの概要

標準ドックレットは、Sun^TM が提供するドックレットで、Javadoc のデフォルトの HTML 形式による API 出力を生成します。この JDK ドキュメントに含まれる Java^TM プラットフォーム用の「API ドキュメント」は、標準ドックレットの出力例です。Javadoc の -doclet オプションを使用してコマンド行で他のドックレットが指定されていない場合は、標準ドックレットが使用されます。

コマンド行からの標準ドックレットの実行

コマンド行で -doclet タグによって他のドックレットが指定されていない場合、標準ドックレットがデフォルトで呼び出されます。たとえば、次のコマンドを実行するとします。

% javadoc myPackage

このコマンドでは、標準ドックレットを使用して myPackage のデフォルトスタイルの HTML API ドキュメントが生成されます。-doclet オプションを指定しないで javadoc を実行した場合は、-doclet オプションを指定して標準ドックレットを呼び出した場合と同じ処理が行われます。つまり、前述のコマンドは、次のコマンドと同等です。

% javadoc -docletpath /home/user/jdk1.5.0/lib/tools.jar \
  -doclet com.sun.tools.doclets.standard.Standard \
  myPackage

または次のコマンドと同等です。

% javadoc -docletpath /home/user/jdk1.5.0/lib/tools.jar \
  -doclet com.sun.tools.doclets.formats.html.HtmlDoclet \
  myPackage

どちらのアプローチでも同じ結果となります。

プログラムからの標準ドックレットの実行

Javadoc ツールには、プログラムから利用できるインタフェースがあります。このインタフェースには、Java 言語で記述された別のプログラムから Javadoc ツールを呼び出すための public メソッドがいくつか用意されています。これらのメソッドは、lib/tools.jar 内の com.sun.tools.javadoc.Main クラスにあります。次にその例を示します。

main を呼び出す場合、次のような短所があります。

(1) 実行するたびに 1 回しか呼び出せません。1.2.x または 1.3.x では、何度も呼び出す必要がある場合は、java.lang.Runtime.exec("javadoc ...") を使用してください。
(2) System.exit() を使用して終了します。System.exit() ではプログラム全体が終了します。
(3) 終了コードが返されません。

public static void main(java.lang.String[] args)

コマンド行インタフェース。

パラメータ:
args - コマンド行パラメータ。

execute メソッドでは、main の短所が解決されています。

public static int execute(java.lang.String[] args)

プログラムインタフェース。
パラメータ:
args - コマンド行パラメータ。
戻り値:
リターンコード。

public static int execute(java.lang.String programName,
                          java.lang.String[] args)

プログラムインタフェース。
パラメータ:
programName - プログラム名 (エラーメッセージ用)。
args - コマンド行パラメータ。
戻り値:
リターンコード。

public static int execute(java.lang.String programName,
                          java.lang.String defaultDocletClassName,
                          java.lang.String[] args)

プログラムインタフェース。
パラメータ:
programName - プログラム名 (エラーメッセージ用)。
defaultDocletClassName - 完全修飾クラス名。
args - コマンド行パラメータ。
戻り値:
リターンコード。

public static int execute(java.lang.String programName,
                          java.io.PrintWriter errWriter,
                          java.io.PrintWriter warnWriter,
                          java.io.PrintWriter noticeWriter,
                          java.lang.String defaultDocletClassName,
                          java.lang.String[] args)

プログラムインタフェース。
パラメータ:
programName - プログラム名 (エラーメッセージ用)。
errWriter - エラーメッセージを受け取る PrintWriter。
warnWriter - エラーメッセージを受け取る PrintWriter。
noticeWriter - エラーメッセージを受け取る PrintWriter。
defaultDocletClassName - 完全修飾クラス名。
args - コマンド行パラメータ。
戻り値:
リターンコード。

例

Java SE のクラスパスを lib/tools.jar に設定して、各オプションと引数を別の文字列として渡します。

com.sun.tools.javadoc.Main.execute(new String[] {"-d", "docs", "-sourcepath", "/home/usr/src", "p1", "p2"});