javadocコマンド

名前

javadoc - Javaソース・ファイルからのAPIドキュメントのHTMLページの生成

シノプシス

javadoc [options] [packagenames] [sourcefiles] [@files]

options

空白で区切られたコマンド行オプションを指定します。 javadocのオプション、拡張オプション、標準ドックレットのオプションおよび標準ドックレットが提供する追加オプションを参照してください。

packagenames

ドキュメント化するパッケージの名前を空白で区切って、java.lang java.lang.reflect java.awtのように指定します。 サブパッケージもドキュメント化する場合は、-subpackagesオプションを使用してパッケージを指定します。

デフォルトでは、javadocは指定されたパッケージを現在のディレクトリおよびそのサブディレクトリで検索します。 パッケージを検索するディレクトリのリストを指定するには、-sourcepathオプションを使用します。

sourcefiles

ドキュメント化するJavaソース・ファイルの名前を空白で区切って、Class.java Object.java Button.javaのように指定します。 デフォルトでは、javadocは指定されたクラスを現在のディレクトリで検索します。 ただし、クラス・ファイルのフル・パスを指定し、ワイルドカード文字を使用することができます。たとえば、/home/src/java/awt/Graphics*.javaのように指定します。 現在のディレクトリからの相対パスを指定することもできます。

@files

javadocツール・オプション、パッケージ名およびソース・ファイル名を任意の順序で並べたリストが含まれているファイルの名前を指定します。

説明

javadocツールは、一連のJavaソース・ファイルにある宣言およびドキュメンテーション・コメントを解析し、デフォルトではpublicクラス、protectedクラス、ネストされたクラス(匿名の内部クラスは除く)、インタフェース、コンストラクタ、メソッドおよびフィールドについて説明した対応するHTMLページを生成します。 javadocルールを使用すると、APIドキュメントや、一連のソース・ファイルの実装ドキュメントを生成できます。

javadocツールは、パッケージ全体、個々のソース・ファイル、またはその両方に対して実行できます。 パッケージ全体をドキュメント化する場合は、-subpackagesオプションを使用して、ディレクトリとそのサブディレクトリを再帰的にたどるか、パッケージ名の明示的なリストを渡すことができます。 個々のソース・ファイルをドキュメント化する場合は、Javaソース・ファイル名のリストを渡します。 javadocツールの使用方法の詳細は、『Java Platform, Standard Edition Javadocガイド』のjavadocの概要に関する情報を参照してください。

適合性

標準ドックレットではドキュメンテーション・コメントの内容の適合性が検証されることはなく、ドキュメンテーション・コメントのエラーを修正しようとすることもありません。 javadocを実行するユーザーは、整合性のない出力やJavaScriptなどの実行可能コンテンツを含む出力を生成する際に生じる可能性のある問題について認識しておく必要があります。 標準ドックレットには、開発者がドキュメンテーション・コメントの一般的な問題を検出するのに役立つdoclint機能がありますが、生成された出力を適切な適合性およびその他のチェック・ツールでチェックすることもお薦めします。

HTML5ドキュメントの適合性要件の詳細は、HTML5仕様のConformance requirementsを参照してください。 Webページに関連したセキュリティ問題の詳細は、Open Web Application Security Project (OWASP)のページを参照してください。

javadocのオプション

次のjavadocの基本オプションは、対応するjavacオプションと同等です。 これらのオプションの使用方法の詳細は、javacの「標準オプション」を参照してください:

• --add-modules

• -bootclasspath

• --class-path、-classpathまたは-cp

• --enable-preview

• -encoding

• -extdirs

• --limit-modules

• --module

• --module-pathまたは-p

• --module-source-path

• --release

• -source

• --source-pathまたは-sourcepath

• --system

• --upgrade-module-path

次のオプションは、javadocの基本オプションであり、対応するjavacオプションと異なります。

ノート:

--形式のオプションをサポートするツールでは、GNU形式のオプションで空白のかわりに等号(=)を使用して、オプションの名前とその値を区切ることができます。

-breakiterator

BreakIteratorで最初の文を計算します。 最初の文は、パッケージ、クラス、またはメンバーのサマリーにコピーされ、アルファベット順のインデックスにコピーされます。 BreakIteratorクラスは、英語を除くすべての言語の文の終わりを判断するために使用されます。

• 英語のデフォルトの文-オンライン・アルゴリズム---ピリオドに停止し、その後に空白またはHTMLブロック・タグを付加します(例: <P>)。

• Breakiterator文ブレーク・アルゴリズム --- 次の単語が大文字で始まるときに、ピリオド、疑問符、または感嘆符が後に続くスペースで停止します。 このアルゴリズムでは、ほとんどの省略表記が処理されます(「The serial no. is valid」は処理されるが「Mr. Smith」は処理されない)。 -breakiteratorオプションは、HTMLタグや、数字または記号で始まる文では停止しません。 アルゴリズムは、HTMLタグに埋め込まれている場合でも、../filenameの最後のピリオドで停止します。

-doclet class

代替ドックレットを使用して出力を生成します。 完全修飾名を使用してください。 このドックレットにより、出力の内容と形式が定義されます。 -docletオプションが使用されていない場合、javadocツールは、標準ドックレットを使用してデフォルトのHTML形式を生成します。 このクラスには、start(Root)メソッドが含まれていなければなりません。 この起動クラスへのパスは、-docletpathオプションによって定義されます。

-docletpath path

ドックレット・クラス・ファイル(-docletオプションで指定)と、それが依存するJARファイルを検索する場所を指定します。 開始クラス・ファイルがJARファイル内にある場合、このオプションではそのJARファイルへのパスが指定されます。 絶対パスまたは現在のディレクトリからの相対パスを指定できます。 classpathlistに複数のパスまたはJARファイルが含まれる場合は、Oracle Solaris上のコロン(:)とWindows上のセミコロン(;)で区切る必要があります。 目的のドックレット開始クラスがすでに検索パス内にある場合は、このオプションは不要です。

-exclude pkglist

指定されたパッケージとそのサブパッケージを-subpackagesによって作成されたリストから無条件に除外します。 過去の-subpackagesオプションの指定によって組み込まれたパッケージ、または将来組み込まれるパッケージも除外の対象となります。

次の例では、java.io、java.util、java.mathなどは組み込まれますが、java.netとjava.lang以下のパッケージは除外されます。 これらの例では、java.langのサブパッケージであるjava.lang.refは除外されます。

• Oracle Solaris、LinuxおよびOS X:

  javadoc -sourcepath /home/user/src -subpackages java -exclude java.net:java.lang

• Windows:

  javadoc -sourcepath \user\src -subpackages java -exclude java.net:java.lang

--expand-requires value

javadocツールに、ドキュメント化するモジュールのセットを展開するように指示します。 デフォルトでは、コマンドラインで明示的に与えられたモジュールだけが文書化されています。 次の値をサポートします:

• transitive: これらのモジュールの必要なすべての推移的な依存性を追加で含めます。

• all: すべての依存性を含めます。

-helpまたは--help

オンライン・ヘルプを表示します。javadocおよびdocletのコマンド行オプションが一覧表示されます。

--help-extraまたは-X

非標準オプションの形式を出力して終了します。

-Jflag

javadocツールを実行するJava Runtime Environment (JRE)に、flagを直接渡します。 たとえば、生成ドキュメントを処理するためにシステムで32Mバイトのメモリーを確保しておく必要がある場合は、-Xmxオプションをjavadoc -J-Xmx32m -J-Xms32m com.mypackageのように呼び出します。 ただし、-Xmsは初期メモリーのサイズを設定するだけなので、オプションです。これは、必要なメモリーの最小サイズがわかっている場合に便利です。

Jとflagの間には空白を入れません。

javadocツールを実行するために使用しているJREのバージョンをレポートするには、-versionオプションを使用します。

javadoc -J-version
java version "10-ea" 2018-03-20
Java(TM) SE Runtime Environment 18.3 (build 10-ea+36)
Java HotSpot(TM) 64-Bit Server VM 18.3 (build 10-ea+36, mixed mode)

-locale name

javadocツールがドキュメントを生成するときに使用するロケールを指定します。 この引数は、en_US (英語、アメリカ合衆国)やen_US_WIN (Windowsの変形)のように、java.util.Localeドキュメントで説明されているロケールの名前です。

ノート:

-localeオプションは、標準ドックレットまたはその他の任意のドックレットが提供する、すべてのオプションより前(左側)に指定する必要があります。 そうしないと、ナビゲーション・バーが英語で表示されます。 このコマンド行オプションだけは、指定する順序に依存します。

ロケールを指定すると、指定したロケールのリソース・ファイルがjavadocツールによって選択されて、メッセージ(ナビゲーション・バー、リストと表の見出し、ヘルプ・ファイルの目次、stylesheet.cssファイルのコメントなどの文字列)のために使用されます。 また、アルファベット順にソートされるリストのソート順、および最初の文の末尾を判別するための文の区切り文字も、指定したロケールによって決まります。 ただし、-localeオプションは、ドキュメント化されるクラスのソース・ファイル内で指定されているドキュメンテーション・コメントのテキストのロケールを決定するものではありません。

-package

package、protected、およびpublicのクラスとメンバーだけを表示します。

-private

すべてのクラスとメンバーを表示します。

-protected

protectedおよびpublicのクラスとメンバーだけを表示します。 これはデフォルトです。

-public

publicのクラスおよびメンバーのみを表示します。

-quiet

メッセージを抑制し、警告とエラーだけが表示されるようにして、これらを特定しやすくします。 version文字列も抑制します。

--show-members value

(フィールドまたはメソッド)をドキュメント化するメンバーを指定します。ここで、valueは次のいずれかになります:

• protected: デフォルト値はprotectedです。

• public: public値のみを表示します。

• package: public、protectedおよびpackageのメンバーを表示します。

• private: すべてのメンバーを表示します。

--show-module-contents value

モジュール宣言のドキュメント化の粒度を指定します。valueにはapiまたはallを指定できます。

--show-packages value

ドキュメント化されるモジュール・パッケージを指定します。valueには、exportedまたはallパッケージを指定できます。

--show-types value

どのタイプ(クラス、インタフェースなど)をドキュメント化するかを指定し、valueには次のいずれかを指定できます。

• protected: デフォルト値です。 公開型と保護型を示します。

• public: public値のみを表示します。

• package: public、protectedおよびpackageタイプを表示します。

• private: すべてのタイプを表示します。

-subpackages subpkglist

ソース・ファイルから指定されたパッケージおよびそのサブパッケージ内に再帰的にドキュメントを生成します。 このオプションは、ソース・コードに新しいサブパッケージを追加する際に便利です。新しいサブパッケージは自動的に組み込まれます。 各package引数は、任意の最上位サブパッケージ(javaなど)または完全修飾のパッケージ(javax.swingなど)になります。ソース・ファイルを含んでいる必要はありません。 どのオペレーティング・システムでも、引数はコロンで区切られます。 ワイルドカードは使用できません。 パッケージの検索場所を指定するには、-sourcepathを使用します。 このオプションは、ソース・ツリーにあるがパッケージには属していないソース・ファイルを処理しません。

たとえば、次のコマンドは、javaおよびjavax.swingという名前のパッケージとこれらのサブパッケージ全部のドキュメントを生成します。

• Oracle Solaris、LinuxおよびOS X:

  javadoc -d docs -sourcepath /home/user/src -subpackages java:javax.swing

• Windows:

  javadoc -d docs -sourcepath \user\src -subpackages java:javax.swing

-verbose

javadocツールの実行中に詳細なメッセージを表示します。 -verboseオプションを指定しない場合、ソース・ファイルのロード、ドキュメントの生成、(ソース・ファイルごとに1つのメッセージ)およびソートについてのメッセージが表示されます。 -verboseオプションを指定すると、各Javaソース・ファイルを解析するミリ秒数を指定する追加メッセージが出力されます。

--version

バージョン情報を出力します。

拡張オプション

ノート:

javadocの拡張オプションは、予告なく変更される可能性があります。

次のjavadocの拡張オプションは、対応するjavacオプションと同等です。 これらのオプションの使用方法の詳細は、javacの「追加オプション」を参照してください:

• --add-exports

• --add-reads

• --patch-module

• -Xmaxerrs

• -Xmaxwarns

次のjavadocの拡張オプションは、対応するjavacオプションと異なります。

-Xmodule:module-name

コンパイルするクラスが属するモジュールを指定します。

-Xold

従来のjavadocツールを呼び出します。

標準ドックレット・オプション

次のオプションは、標準ドックレットによって提供されます。

--add-stylesheet file

生成されたドキュメントのスタイルシート・ファイルを追加します。 このオプションは、ドキュメントに含まれる追加のスタイルシートを指定するために、1回以上使用できます。

コマンド行の例:

javadoc --add-stylesheet new_stylesheet_1.css --add-stylesheet new_stylesheet_2.css pkg_foo

--allow-script-in-comments

オプションおよびコメントでJavaScriptを許可します

-author

生成ドキュメントに、@authorのテキストを組み込みます。

-bottom html-code

各出力ファイルの最下部に配置するテキストを指定します。 このテキストは、下部ナビゲーション・バーより下の、ページの最下部に配置されます。 テキストには、HTMLタグと空白を含めることができますが、これらを含める場合は、テキストを引用符で囲まなければなりません。 テキスト内の内部引用符には、エスケープ文字を使用してください。

-charset name

このドキュメント用のHTML文字セットを指定します。 名前は、「IANAレジストリ、キャラクタ・セット」で指定された優先MIME名でなければなりません。

次に例を示します。

javadoc -charset "iso-8859-1" mypackage

このコマンドにより、生成されるすべてのページの先頭に次の行が挿入されます。

<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">

METAタグについては、「HTML標準(4197265および4137321)、HTMLドキュメント表現」で説明します。

-d directory

javadocツールで生成されたHTMLファイルを保存する生成先ディレクトリを指定します。 -dオプションを省略すると、ファイルは現在のディレクトリに保存されます。 directoryの値には、絶対ディレクトリ、または現在の作業ディレクトリからの相対ディレクトリを指定できます。 javadocツールを実行すると生成先ディレクトリが自動的に作成されます。

• Oracle Solaris、LinuxおよびOS X たとえば、次のコマンドでは、com.mypackageパッケージのドキュメントが生成され、その結果が/user/doc/ディレクトリに保存されます。

  javadoc -d /user/doc/ com.mypackage

• Windows: たとえば、次のコマンドでは、com.mypackageパッケージのドキュメントが生成され、その結果が\user\doc\ディレクトリに保存されます。

  javadoc -d \user\doc\ com.mypackage

-docencoding name

生成されるHTMLファイルのエンコーディングを指定します。 名前は、「IANAレジストリ、キャラクタ・セット」で指定された優先MIME名でなければなりません。

javadocエンコーディング・コマンドで使用できるオプションは3つあります。 -encodingオプションはjavadocツールによって読み取られるファイルのエンコーディングに使用され、-docencodingおよび-charsetオプションはツールによって書き込まれるファイルのエンコーディングに使用されます。 使用可能な3つのオプションのうち、1つのエンコーディング・コマンドで使用できるのは、最大でも入力エンコーディング・オプションと1つの出力エンコーディング・オプションのみです。 入力エンコーディング・オプションと出力エンコーディング・オプションの両方を1つのコマンドで指定する場合は、それらを同じ値にする必要があります。 いずれの出力オプションも指定しなかった場合、ツールによってデフォルトで入力エンコーディングに設定されます。

次に例を示します。

javadoc -docencoding "iso-8859-1" mypackage

-docfilessubdirs

再帰的にdoc-fileサブディレクトリをコピーします

-doctitle html-code

概要ファイルの最上部の近くに配置するタイトルを指定します。 titleタグに指定されたテキストは中央揃えになり、レベル1の見出しとして、上部ナビゲーション・バーのすぐ下に置かれます。 titleタグには、HTMLタグと空白を含めることができますが、これらを含める場合は、タイトルを引用符で囲まなければなりません。 titleタグ内のその他の引用符は、エスケープする必要があります。 例: javadoc -header "<b>My Library</b><br>v1.0" com.mypackage

-excludedocfilessubdir name

指定された名前のdocファイルのサブディレクトリをすべて除外します。 doc-filesディレクトリの深いコピーを有効にします。 コピー先には、サブディレクトリとすべての内容が再帰的にコピーされます。 たとえば、ディレクトリdoc-files/example/imagesとその内容がすべてコピーされます。 サブディレクトリを除外するオプションもあります。

-footer html-code

各出力ファイルの下端に配置するフッター・テキストを指定します。 html-codeの値は、下部ナビゲーション・バーの右側に配置されます。 html-codeの値には、HTMLタグと空白を含めることができますが、これらを含める場合は、html-codeの値を引用符で囲まなければなりません。 フッター内の内部引用符には、エスケープ文字を使用してください。

--frames

生成された出力(default)でフレームの使用を有効にします。

-group namep1:p2

概要ページで、指定したパッケージをグループ化します。

-header html-code

各出力ファイルの上端に配置するヘッダー・テキストを指定します。 ヘッダーは、上部ナビゲーション・バーの右側に配置されます。 headerには、HTMLタグと空白を含めることができますが、これらを含める場合は、headerを引用符で囲まなければなりません。 ヘッダー内の内部引用符には、エスケープ文字を使用してください。 例: javadoc -header "<b>My Library</b><br>v1.0" com.mypackage

-helpfile filename

上部および下部のナビゲーション・バーの「ヘルプ」リンクのリンク先となるファイルを組み込みます。 このオプションを指定しない場合、javadocツールは、javadocツールでハードコードされたヘルプ・ファイルhelp-doc.htmlを作成します。 このオプションを使うと、そのデフォルトの動作をオーバーライドできます。 filenameには任意の名前を指定でき、help-doc.htmlには限定されません。 javadocツールは、このオプションでの指定に従って、ナビゲーション・バーにあるリンクを調整します。 次に例を示します。

• Oracle Solaris、LinuxおよびOS X:

  javadoc -helpfile /home/user/myhelp.html java.awt.

• Windows:

  javadoc -helpfile C:\user\myhelp.html java.awt.

-html4

HTML 4.0.1の出力を生成します。 このオプションを使用しない場合、-html4がデフォルトです

-html5

HTML 5出力を生成します。 このオプションを使用しない場合、-html4がデフォルトです。

--javafxまたは-javafx

JavaFX機能を有効にします。

-keywords

HTMLキーワードの<META>タグを、クラスごとに生成されるファイルに追加します。 これらのタグは、<META>タグを検索するサーチ・エンジンがページを見つける場合に役立ちます。 インターネット全体を検索する検索エンジンのほとんどは<META>タグを参照しません。ページが誤用している可能性があるからです。 検索を自身のWebサイトに限定している企業では、サーチ・エンジンが<META>タグを調べることによってメリットを得られます。 <META>タグには、クラスの完全修飾名と、フィールドおよびメソッドの修飾されていない名前が含まれます。 コンストラクタは、クラス名と同じであるため含まれません。 たとえば、クラスStringは次のキーワードで開始します。

<META NAME="keywords" CONTENT="java.lang.String class">
<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">
<META NAME="keywords" CONTENT="length()">
<META NAME="keywords" CONTENT="charAt()">

-link url

javadocにより生成された、外部参照クラスの既存のドキュメントへのリンクを作成します。 url引数は、javadocにより生成された外部ドキュメントを含むディレクトリの絶対URLまたは相対URLです。 指定した1回のjavadocツールの実行で、複数の-linkオプションを指定して、複数のドキュメントへのリンクを作成できます。

このurlディレクトリ内にpackage-listまたはelement-listファイルが存在する必要があります(存在しない場合は、-linkofflineオプションを使用します)。

ノート:

package-listおよびelement-listファイルは、APIドキュメントの生成時にjavadocツールによって生成され、ユーザーはこれを変更できません。

javadocツールを使用してパッケージをドキュメント化する場合、APIで宣言されているパッケージを特定するためにpackage-listファイルが使用されます。 モジュールのAPIドキュメントを生成する場合、javadocツールはelement-listファイルを使用して、APIで宣言されたモジュールおよびパッケージを特定します。

javadocツールは適切なリスト・ファイルから名前を読み取り、そのURLにあるパッケージまたはモジュールへのリンクを作成します。

javadocツールを実行すると、作成される<A HREF>リンク内にurlの値がコピーされます。 したがって、urlはファイルへのURLではなくディレクトリへのURLである必要があります。

url への絶対リンクを使用すると、ユーザーのドキュメントを任意のWebサイト上のドキュメントにリンクできます。相対位置へリンクするだけでよい場合は相対リンクを使用できます。 相対リンクを使用する場合、ユーザーが渡す値は、生成先ディレクトリ(-dオプションで指定)からリンク先となるパッケージを含むディレクトリへの相対パスにする必要があります。 絶対リンクを指定すると、通常はHTTPリンクが使用されます。 Webサーバーを持たないファイル・システムにリンクする場合は、ファイル・リンクを使用できます。 生成されたドキュメントにアクセスするすべてのユーザーが同じファイル・システムを共有する場合にのみ、ファイル・リンクを使用します。 いずれの場合も、そしてすべてのオペレーティング・システムにおいて、URLが絶対か相対か、およびhttps:かhttp:かfile:かにかかわらず、URL Memo: Uniform Resource Locatorsで指定されているとおりにセパレータとしてスラッシュを使用します。

-link https://<host>/<directory>/<directory>/.../<name>
-link http://<host>/<directory>/<directory>/.../<name>
-link file://<host>/<directory>/<directory>/.../<name>
-link <directory>/<directory>/.../<name>

-linkoffline url1 url2

このオプションは、-linkオプションのバリエーションです。 どちらも、javadocによって生成された、外部参照クラスのドキュメントへのリンクを作成します。 指定した1回のjavadocツールの実行で、複数の-linkofflineオプションを指定できます。

次の場合に-linkofflineオプションを使用します。

• javadocツールがWeb接続でアクセスできないWeb上のドキュメントへのリンクを作成する場合

• 外部ドキュメントのpackage-listまたはelement-listファイルにアクセスできないか、またはこれらのファイルがURLの場所には存在しないが別の場所に存在し、package-listまたはelement-listファイルで指定できる(通常、ローカル)場合。

ノート:

package-listおよびelement-listファイルは、APIドキュメントの生成時にjavadocツールによって生成され、ユーザーはこれを変更できません。

url1にWorld Wide Web上でしかアクセスできない場合は、-linkofflineオプションを指定することにより、ドキュメントを生成するにはjavadocツールでWebに接続できる必要があるという制約がなくなります。

-linkofflineオプションのもう1つの用途は、ドキュメントを更新するためのワークアラウンドとして使用することです。 パッケージまたはモジュールのセット全体に対してjavadocツールを実行した後、変更した一部のパッケージまたはモジュールのセットに対して再度javadocツールを実行できます。これにより、更新されたファイルをオリジナルのセットに挿入できます。

たとえば、-linkofflineオプションは2つの引数を取ります。 最初の引数は<a href>リンクに埋め込まれる文字列に使用され、2番目の引数はpackage-listまたはelement-listファイルを検索する場所をjavadocツールに示します。

url1またはurl2の値は、リンク先にする、javadocによって生成された外部ドキュメントを含むディレクトリの絶対URLまたは相対URLです。 相対値の場合、-dオプションで指定される生成先ディレクトリを基準にした、リンクされるパッケージのルートの相対パスを指定する必要があります。 -linkオプションのurlを参照してください。

-linksource

各ソース・ファイル(行番号付き)のHTMLバージョンを作成し、標準HTMLドキュメントからソース・ファイルへのリンクを追加します。 リンクは、ソース・ファイル内に宣言されているクラス、インタフェース、コンストラクタ、メソッド、フィールドに対して作成されます。 そうでない場合、たとえばデフォルト・コンストラクタや生成されたクラスに対しては、リンクは作成されません。

このオプションは、-public、-package、-protected、-privateの各オプションとは関係なく、privateクラス、privateフィールド、privateメソッドの本体を始めとする組み込まれたソース・ファイル内のすべての非公開実装の詳細を公開します。 -privateオプションを指定しないかぎり、privateクラスやprivateインタフェースの一部には、リンクを介してアクセスできないことがあります。

各リンクは、その宣言内の識別子名の上に作成されます。 たとえば、Buttonクラスのソース・コードへのリンクは、「Button」という語の上に作成されます。

public class Button extends Component implements Accessible

ButtonクラスのgetLabelメソッドのソース・コードへのリンクは、「getLabel」という語の上に作成されます。

public String getLabel()

--main-stylesheet fileまたは-stylesheetfile file

生成されたドキュメントで使用されるCSSスタイルの定義を含む代替スタイルシート・ファイルのパスを指定します。 このオプションを使うと、そのデフォルトの動作をオーバーライドできます。 オプションを指定しなかった場合、javadocツールはデフォルトのスタイルシートを作成して使用します。 ファイル名には任意の名前を指定でき、stylesheet.cssには限定されません。 推奨される形式は、--main-stylesheetオプションです。

コマンド行の例:

javadoc --main-stylesheet main_stylesheet.css pkg_foo

-nocomment

主説明およびすべてのタグを含むコメント本文全体を抑制し、宣言だけを生成します。 このオプションを使用すると、最初は新しい目的のために意図されたソース・ファイルを再利用できるため、新しいプロジェクトの初期段階でスケルトンHTMLドキュメントを作成できます。

-nodeprecated

非推奨APIをドキュメントに生成しないようにします。 このオプションを指定すると、-nodeprecatedlistオプションを指定した場合と同じ効果があり、ドキュメントの残り部分全体で非推奨APIが生成されなくなります。 このオプションは、コードを記述しているとき、非推奨のコードによって気を散らされたくない場合に便利です。

-nodeprecatedlist

非推奨APIのリストを含むファイル(deprecated-list.html)、およびナビゲーション・バーのそのページへのリンクが生成されないようにします。 javadocツールは、ドキュメントの残り部分では非推奨APIを引き続き生成します。 このオプションは、非推奨APIがソース・コードに含まれておらず、ナビゲーション・バーをすっきりと見せたい場合に便利です。

--no-frames

生成された出力でフレームの使用を無効にします。

-nohelp

出力の各ページの最上部と最下部にあるナビゲーション・バーから「ヘルプ」リンクを省略します。

-noindex

生成ドキュメントから、索引を省略します。 デフォルトでは、索引が生成されます。

-nonavbar

通常は生成されるページの最上部と最下部に表示されるナビゲーション・バー、ヘッダー、およびフッターを生成しないようにします。 -nonavbarオプションは、-bottomオプションには影響を与えません。 -nonavbarオプションは、印刷するためだけにファイルをPostScriptまたはPDFに変換する場合など、内容だけが重要で、ナビゲーションの必要がない場合に便利です。

-noqualifier name1:name2...

修飾子のリストを出力から除外します。 クラスまたはインタフェースの名前が表示される場所からパッケージ名が削除されます。

次の例では、すべてのパッケージ修飾子を省略します。-noqualifier all

次の例では、パッケージ修飾子java.langおよびjava.ioを省略します。-noqualifier java.lang:java.io

次の例では、javaで始まるパッケージ修飾子とcom.sunのサブパッケージを省略しますが、javax: -noqualifier java.*:com.sun.*は省略しません。

パッケージ修飾子が上記の動作に従って表示される場合、名前は適切に短縮されます。 この規則は、-noqualifierオプションを使用したかどうかにかかわらず有効です。

-nosince

生成ドキュメントから、@sinceタグに対応する「導入されたバージョン」セクションを省略します。

-notimestamp

タイムスタンプが抑制されます。各ページ先頭近くにある、生成されたHTML内のHTMLコメントにタイムスタンプが隠されます。 javadocツールを2つのソース・ベースで実行し、それらに対してdiffを実行する場合、-notimestampオプションを使用すると、タイムスタンプによってdiffが発生しなくなるので便利です(このオプションを使用しないと、各ページでdiffになります)。 タイムスタンプには、javadocツールのリリース番号が含まれています。

-notree

生成された文書からクラスおよびインタフェースの階層ページを除外します。 これらのページには、ナビゲーション・バーの「ツリー」ボタンからアクセスできます。 デフォルトでは、階層が生成されます。

--override-methods (detail|summary)

詳細または要約セクション内のオーバーライドされるメソッドをドキュメント化します。

-overview filename

javadocツールで、filenameによって指定されたソース・ファイルから概要ドキュメント用のテキストを取得し、そのテキストを概要ページ(overview-summary.html)に配置するように指定します。 ファイル名で指定された相対パスは、現在の作業ディレクトリからの相対パスです。

filenameの値とpathには、それぞれ任意の名前と場所を指定できますが、通常は、overview.htmlという名前を付けて、ソース・ツリー内の最上位のパッケージ・ディレクトリがあるディレクトリに配置します。 この場所に配置すると、-sourcepathオプションによってこのファイルが指し示されるので、パッケージをドキュメント化する際にpathが不要になります。

• Oracle Solaris、LinuxおよびOS X たとえば、java.langパッケージのソース・ツリーが/src/classes/java/lang/の場合、概要ファイルを/src/classes/overview.htmlに配置できます。

• Windows: たとえば、java.langパッケージのソース・ツリーが\src\classes\java\lang\の場合、概要ファイルは\src\classes\overview.htmlに配置できます

概要ページが作成されるのは、javadocツールに複数のパッケージ名を渡した場合のみです。 概要ページのタイトルは、-doctitleによって設定されます。

-serialwarn

@serialタグがない場合は、コンパイル時に警告を生成します。 デフォルトでは、Javadocはシリアル警告を生成しません。 このオプションを使用すると、直列化の警告が表示されるので、デフォルトの直列化可能フィールドとwriteExternalメソッドを適切にドキュメント化するのに役立ちます。

-sourcetab tablength

ソース内の各タブが使用する空白文字の数を指定します。

-splitindex

索引ファイルをアルファベットごとに複数のファイルに分割し、文字ごとに1つのファイルと、アルファベット以外の記号で始まる索引エントリ用に1つのファイルを作成します。

-tag name:locations:header

単一引数のカスタム・タグを指定します。 javadocツールでタグ名のスペル・チェックを行うには、ソース・コード内のすべてのカスタム・タグに-tagオプションを組み込むことが重要です。今回の実行で出力されないタグは、Xを付けて無効にします。 コロン(:)は常にセパレータです。 -tagオプションは、タグの見出しheaderを太字で出力します。その次の行には、このオプションの単一の引数で指定したテキストが続きます。 ブロック・タグと同様、この引数のテキストにはインライン・タグを含めることができます。このインライン・タグも解釈されます。 出力は、引数を1つ取る標準のタグ(@return、@authorなど)の出力とよく似ています。 header値を省略すると、nameが見出しになります。

-taglet class

そのタグのドキュメントの生成に使用されるタグ・レットの完全修飾名を指定します。 classの値には完全修飾名を使用してください。 このタグレットは、カスタム・タグのテキスト引数の数も定義します。 タグレットは、これらの引数を受け付け、処理し、出力を生成します。

タグレットは、ブロック・タグまたはインライン・タグで便利です。 タグレットは任意の数の引数をとることができます。また、テキストを太字にする、箇条書きを作成する、テキストをファイルに書き出す、その他のプロセスを開始するなどのカスタム動作を実装できます。 タグレットで指定できるのは、タグの配置場所と配置形式のみです。 その他のすべての決定は、ドックレットによって行われます。 タグレットを使用しても、包含クラスのリストからクラス名を削除するなどの処理は実行できません。 ただし、タグのテキストをファイルに出力したり、別のプロセスをトリガーするなどの副作用は得られます。 タグレットのパスを指定するには、-tagletpathオプションを使用します。 以下は、生成されるページの「Parameter」と「Throws」の間に「To Do」タグレットを挿入する例です。

-taglet com.sun.tools.doclets.ToDoTaglet
-tagletpath /home/taglets
-tag return
-tag param
-tag todo
-tag throws
-tag see

-tagオプションのかわりに-tagletオプションを使用することもできますが、読みにくくなる場合があります。

-tagletpath tagletpathlist

タグレットのクラス・ファイルの検索パスを指定します。 tagletpathlistには、コロン(:)で区切って複数のパスを含めることができます。 javadocツールは、指定されたパスのすべてのサブディレクトリを検索します。

-top html-code

各出力ファイルの最上部に配置するテキストを指定します。

-use

クラスとパッケージの使用ページを作成します。 ドキュメント化されるクラスおよびパッケージごとに1つの「使用」ページを組み込みます。 このページには、その特定のクラスまたはパッケージのAPIを使っているパッケージ、クラス、メソッド、コンストラクタ、およびフィールドが記述されます。 たとえば、クラスCを例にとると、クラスCを使っているものとしては、Cのサブクラス、Cとして宣言されているフィールド、Cを返すメソッド、および、型Cのパラメータを持つメソッドとコンストラクタがあります。 たとえば、String型の「使用」ページを見てみましょう。 java.awt.FontクラスのgetNameメソッドはタイプStringを返すため、getNameメソッドはStringを使用し、getNameメソッドはStringの「使用」ページに表示されます。 これは、実装ではなく、APIの使用のみを示しています。 あるメソッドが、その実装の中でStringを使用していても、引数として文字列を取ったり、文字列を返したりしない場合は、Stringの使用とは見なされません。生成された「使用」ページにアクセスするには、目的のクラスまたはパッケージに移動し、ナビゲーション・バーの「使用」リンクをクリックします。

-version

生成されたドキュメントにバージョン・テキストを含めます。 このテキストは、デフォルトでは省略されます。 使用しているjavadocツールのバージョンを確認するには、-J-versionオプションを使用します。

-windowtitle title

HTMLの<title>タグに配置するタイトルを指定します。 titleタグに指定されたテキストは、ウィンドウのタイトルや、このページに対して作成されたブラウザのブックマーク(お気に入り)に表示されます。 このタイトルにはHTMLタグを含めないでください。タイトルにHTMLタグが含まれていると、ブラウザがタグを正しく解釈できません。 titleタグ内の内部引用符には、エスケープ文字を使用してください。 -windowtitleオプションが省略されている場合、javadocツールは、-windowtitleオプションのかわりに-doctitleオプションの値を使用します。 例: javadoc -windowtitle "My Library" com.mypackage

標準ドックレットが提供する追加オプション

次に示すのは、標準ドックレットによって提供される追加オプションであり、予告なく変更される可能性があります。 追加オプションはあまり一般的に使用されない可能性があり、そうでなければ拡張と見なされます。

-Xdoclint

Javadocコメントの問題の推奨チェックを有効にします。

-Xdoclint:(all|none|[-]group)

不正な参照の特定のチェック、アクセシビリティの欠如、Javadocコメントの欠落を有効または無効にし、無効なJavadoc構文と欠落したHTMLタグのエラーを報告します。

javadocツールでこのオプションを使用すると、生成された出力に含まれているすべてのドキュメンテーション・コメントをチェックできます。 生成される出力に含める項目は、標準オプション-public、-protected、-packageおよび-privateを使用して選択できます。

-Xdoclintを有効にすると、javacコマンドに似たメッセージによって問題が報告されます。 javadocツールは、メッセージ、ソース行のコピー、およびエラーが検出された正確な位置を指すキャレットを出力します。 メッセージは警告またはエラーです。どちらになるかは、その重要度、および生成されたドキュメントに対してバリデータを実行した場合にエラーを招く可能性によって決まります。 たとえば、不正な参照やJavadocコメントの欠落は、javadocツールが無効なHTMLを生成する原因にはならないため、このような問題は警告として報告されます。 構文エラーやHTML終了タグの欠落は、javadocツールが無効な出力を生成する原因になるため、このような問題はエラーとして報告されます。

-Xdoclintオプションは、リクエストされたマークアップに基づいて入力コメントを有効にします。

デフォルトでは、-Xdoclintオプションは有効になっています。 無効にするには、-Xdoclint:noneオプションを使用します。

次のオプションにより、-Xdoclintオプションで報告する項目が変更されます。

• -Xdoclint none: -Xdoclintオプションを無効にします。

• -Xdoclint group: groupチェックを有効にします

• -Xdoclint all: すべてのチェック・グループを有効にします

• -Xdoclint all,- group: groupチェックを除くすべてのチェックを有効にします。

変数groupは、次のいずれかの値を取ります。

• accessibility: アクセシビリティ・チェッカで検出されるような問題をチェックします(たとえば、<table>タグにキャプション属性やサマリー属性が指定されていない場合)。

• html: 高レベルのHTMLの問題を検出します(ブロック要素がインライン要素の内側にある、終了タグを必要とする要素が閉じていない、など)。 このルールは、選択された標準ドックレットhtml出力生成に基づいて、HTML4仕様およびHTML5仕様から導出されます。 このタイプのチェックを使用すると、一部のブラウザで意図したとおりに解釈されない可能性があるHTMLの問題をjavadocツールで検出できます。

• missing: Javadocコメントまたはタグの欠落をチェックします(たとえば、コメントやクラスが見つからない、メソッドに@returnタグや類似のタグがない、など)。

• reference: JavadocタグからのJava API要素への参照に関連する問題(たとえば、@seeで見つからないアイテム、@param)の後の不正な名前)を確認します。

• syntax: 低レベルの問題をチェックします。たとえば、山カッコ(<と>)やアンパサンド(&)がエスケープされていない、Javadocタグが無効である、などです。

-Xdoclintオプションは複数回指定できるため、複数のカテゴリのエラーと警告をチェックできます。 または、前述のオプションを使用して、エラーと警告のカテゴリを複数指定することもできます。 たとえば、ファイルfilenameのHTML、構文、およびアクセシビリティの問題をチェックするには、次のコマンドのどちらかを使用します。

javadoc -Xdoclint:html -Xdoclint:syntax -Xdoclint:accessibility filename

javadoc -Xdoclint:html,syntax,accessibility filename

ノート:

javadocツールでは、これらのチェックの完全性は保証されません。 具体的に言うと、これは完全なHTMLコンプライアンス・チェッカではありません。 -Xdoclintオプションの目的は、一般的なエラーの大部分をjavadocツールで報告できるようにすることです。

javadocツールでは、無効な入力の修正は試みず、単に報告します。

-Xdoclint/package:[-]packages

特定のパッケージのチェックを有効または無効にします。packagesはカンマで区切られたパッケージ指定子のリストです。 パッケージ指定子は、パッケージの修飾名またはパッケージ名の接頭辞の後に*を指定(指定されたパッケージのすべてのサブパッケージまで拡張)したものです。 指定されたパッケージのチェックを無効にするには、パッケージ指定子の先頭に-を付けます。

-Xdocrootparent url

Javadocコメント内の/..が後に続く@docRootのすべてをurlで置換します。