標準ドックレット

標準ドックレットの概要

標準ドックレットは、Oracleが提供するドックレットで、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()を使用して終了します。これにより、プログラム全体が終了します。(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"});