% 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どちらのアプローチでも同じ結果となります。
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"});
src/share/classes/com/sun/tools/doclets
ディレクトリにあります。