標準ドックレット

標準ドックレットの概要

標準ドックレットは、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 回しか呼び出せません (1.2.x または 1.3.x の場合)。そこで、2 回以上の呼び出しが必要な場合は、java.lang.Runtime.exec("javadoc ...") を使用します。(2) 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 - コマンド行パラメータ
戻り値:
リターンコード

例

classpath に J2SE の lib/tools.jar を設定した状態で、各オプションおよび引数を別々の文字列として渡します。

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