3 Javadocコマンド

javadocコマンドは、-docletオプションでカスタム・ドックレットが指定されている場合以外は、ドックレットを使用してその出力とデフォルトの標準ドックレットを決定します。オプション名は大文字と小文字が区別されませんが、その引数では大文字と小文字が区別されます。

形式

javadoc  [packages|source-files] [options][@files]

packages

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

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

source-files

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

options

コマンド行オプションをスペースで区切ったものです。

@files

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

説明

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

javadocコマンドは、パッケージ全体、個々のソース・ファイル、またはその両方に対して実行できます。パッケージ全体をドキュメント化する場合は、ディレクトリとそのサブディレクトリを再帰的にたどるために-subpackagesを使用するか、パッケージ名の明示的なリストを渡します。個々のソース・ファイルをドキュメント化する場合は、Javaソース・ファイル名のリストを渡します。

適合性

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

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

ソース・ファイルの処理

javadocコマンドは、末尾にファイル拡張子sourceが付いたファイル以外に、ソース・ファイルで説明する他のファイルも処理します。個々のソース・ファイル名を渡すことによってjavadocコマンドを実行する場合、どのソース・ファイルを処理するかを正確に指定できます。ただし、多くの開発者はこの方法では作業しません。パッケージ名を渡すほうが簡単だからです。ソース・ファイル名を明示的に指定しなくても、javadocコマンドは3つの方法で実行できます。この方法は、パッケージ名を渡す、-subpackagesオプションを使用する、ソース・ファイル名にワイルドカードを使用するという方法です。これらの方法を使用する場合、javadocコマンドは、ソース・ファイルが次のすべての要件を満たしている場合にかぎり、このファイルを処理します。

• ファイル名の接頭辞(.javaを取り除いたもの)が、有効なクラス名になっている。

• ソース・ツリーのルートからの相対的なパス名が、区切り文字をドットに変換すると、有効なパッケージ名になっている。

• パッケージ文には有効なパッケージ名が含まれている。

リンクの処理

javadocコマンドは、処理の実行中に、その実行でドキュメント化されるパッケージ、クラス、およびメンバーの名前に対して、相互参照リンクを追加します。このようなリンクは、次の場所に追加されます。

• 宣言(戻り値の型、引数の型、およびフィールドの型)

• @seeタグから生成された関連項目セクション

• {@link}タグから生成されたインライン・テキスト

• @throwsタグから生成された例外の名前

• インタフェースのメンバーに対する「定義」リンクと、クラスのメンバーに対する「オーバーライド」リンク

• パッケージ、クラス、およびメンバーを列挙しているサマリー表

• パッケージおよびクラスの継承ツリー

• 索引

処理詳細

javadocコマンドは、実行するたびに1つの完全なドキュメントを作成します。以前の実行結果を変更したり直接組み入れたりする追加生成は実行しません。ただし、javadocコマンドでは、以前の実行結果に対してリンクを追加することはできます。

javadocコマンドの実装は、Javaコンパイラを必要とし、Javaコンパイラに依存しています。javadocコマンドは、javacコマンドの一部を呼び出すことによって宣言をコンパイルし、メンバーの実装は無視します。javadocコマンドは、クラス階層を含むクラスの豊富な内部表現とクラスの使用関係を構築して、HTMLドキュメントを生成します。さらに、javadocコマンドは、ソース・コードのドキュメンテーション・コメントから、ユーザーの提供したドキュメントも取得します。

javadocコマンドは、メソッド本体のない純粋なスタブ・ファイルであるソース・ファイル上で実行できます。したがって、APIの実装を記述する前の設計の早い段階で、ドキュメンテーション・コメントを記述してjavadocコマンドを実行できます。

コンパイラに依存することによって、HTML出力は、実際の実装に正確に対応します。実際の実装は、明示的なソース・コードにではなく、暗黙のソース・コードに依存する場合があります。たとえば、javadocコマンドは、コンパイル済みクラス・ファイル内に存在するが、ソース・コード内には存在しないデフォルト・コンストラクタをドキュメント化します。

通常、javadocコマンドでは、ソース・ファイルのコードが不完全またはエラーを含んでいる場合でもドキュメントを生成できます。任意のデバッグやトラブルシューティングを完了する前にドキュメントを生成できます。javadocコマンドはドキュメンテーション・コメントの基本的なチェックを行います。

javadocコマンドは、ドキュメントの内部構造を構築する際、参照クラスをすべてロードします。このため、javadocコマンドは、すべての参照クラスを検索でき、かつそれがブートストラップ・クラス、拡張機能、ユーザー・クラスのいずれであるか判別できる必要があります。

Javadocのドックレット

javadocコマンドの出力の内容と形式は、ドックレットを使ってカスタマイズできます。javadocコマンドには、標準ドックレットと呼ばれるデフォルトの組込みドックレットがあります。標準ドックレットは、HTML形式のAPIドキュメントを生成します。HTML、XML、MIF、RTFなどの好みの出力形式を生成する独自のドックレットを記述できます。

-docletオプションでカスタム・ドックレットが指定されていない場合、javadocコマンドは、デフォルトの標準ドックレットを使用します。javadocコマンドには、使用されているドックレットに関係なく使用できるコマンド行オプションがあります。標準ドックレットでは、これらの他に、いくつかのコマンド行オプションが追加されます。

Javadocドックレットのオプション

javadocツールはモジュール宣言内のドキュメンテーション・コメントをサポートしています。これには--module-pathや--upgrade-module-path、--module-source-pathのようなコマンド行オプションがあり、ドキュメント化されるモジュールのセットを構成し、ドキュメント化されるモジュールの新しいサマリー・ページを生成できます。モジュール関連のオプションが、ドキュメントの生成のために用意されています。次のオプションは、基本オプションであり、すべてのドックレットで使用できます。

--add-modules module(,module)*

初期モジュールに加えて解決するルート・モジュール、または<module>がALL-MODULE-PATHの場合はモジュール・パスのすべてのモジュールを指定します。

--add-exports module/package=other-module(,other-module)*

定義モジュールから追加モジュールに、あるいはother-moduleがALL-UNNAMEDの場合はすべての名前のないモジュールにエクスポートされると見なされるパッケージを指定します。

--add-reads module/package=other-module(,other-module)

指定モジュールで必須と見なされるように追加モジュールを指定します。名前のないモジュールを必須とするにはother-moduleをALL-UNNAMEDとします。

-bootclasspath classpathlist

ブート・クラスが存在するパスを指定します。通常、これらはJavaプラットフォーム・クラスです。bootclasspathは、javadocコマンドがソース・ファイルとクラス・ファイルを探すときに使う検索パスの一部です。

classpathlistパラメータ内で複数のディレクトリを区切るには、次のいずれかのデリミタを使用します。

• Oracle Solaris、LinuxおよびmacOS: コロン(:)

• Windows: セミコロン(;)

注意:

-bootclasspathオプションは、-source、-targetまたは--releaseにJDK 6、7または8を使用するなど古いバージョンのJavaプラットフォームに対してドキュメントを生成しようとしている場合にのみ使用可能です。

-breakiterator

java.text.BreakIteratorの国際化された文境界を使用して、パッケージ、クラス、またはメンバーの英文の主説明における最初の文の終わりを判断します。他のすべてのロケールはすでに、英語言語というロケール固有のアルゴリズムではなくBreakIteratorクラスを使用しています。最初の文は、パッケージ、クラス、またはメンバーのサマリーにコピーされ、アルファベット順のインデックスにコピーされます。BreakIteratorクラスは、英語を除くすべての言語の文の終わりを判断するために、次のように使用されています。

• 英文のデフォルトの文区切りアルゴリズム: 空白文字またはHTMLブロック・タグ(<P>など)が続くピリオドで停止します。

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

• 疑問符で必ず最初の文が終了: 二重引用符が疑問符の後に続く場合、二重引用符も最初の文に含まれますが、その文字で文は終了します。

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

javadocコマンドが参照クラスを検索するパスを指定します。これらはドキュメント化されるクラス、およびそれらのクラスにより参照されるクラスです。

CLASSPATHは、javadocコマンドがユーザー・クラスのファイルを探すときに使うパスを指定する環境変数です。この環境変数は、-classpathオプションによってオーバーライドされます。ディレクトリを区切るには、次のいずれかのデリミタを使用します: Windowsではセミコロン、Oracle Solarisではコロン。

Oracle Solaris、LinuxおよびmacOS: 複数のパスを区切るには、コロン(:)を使用します。たとえば、.:/home/classes:/usr/local/java/classesです

Windows: 複数のパスを区切るには、セミコロン(;)を使用します。たとえば、.;C:\classes;C:\home\java\classesです

javadocコマンドは、指定されたパス以下のすべてのサブディレクトリを検索します。

-sourcepathが省略されている場合、javadocコマンドは、-classpathを使って、ソース・ファイルとクラス・ファイルを検索します(下位互換性のため)。ソース・ファイルとクラス・ファイルを別々のパスから検索する必要がある場合は、-sourcepathと-classpathの両方を使います。

Oracle Solaris、LinuxおよびmacOS: たとえば、com.mypackageをドキュメント化する場合に、そのソース・ファイルがディレクトリ/home/user/src/com/mypackageにあり、このパッケージが/home/user/libにあるライブラリに依存しているときは、次のコマンドを使用します。

javadoc -sourcepath /home/user/src -classpath /home/user/lib com.mypackage 

Windows: たとえば、com.mypackageをドキュメント化する場合に、そのソース・ファイルがディレクトリ\user\src\com\mypackageにあり、このパッケージが\user\libにあるライブラリに依存しているときは、次のコマンドを使用します。

javadoc -sourcepath \user\lib -classpath \user\src com.mypackage

他のツールと同様に、-classpathが指定されていない場合、CLASSPATH環境変数が設定されていれば、javadocコマンドはこの環境変数を使います。どちらも設定されていない場合、javadocコマンドは現在のディレクトリからクラスを検索します。

*というベース名を含むクラス・パス要素は、ディレクトリ内の拡張子.jarまたは.JARを持つすべてのファイルのリストを指定するのと同じとみなされます。

たとえば、ディレクトリmydirにa.jarとb.jarが含まれている場合、クラス・パス要素foo/*はa.jar:b.JARに展開されます。ただし、JARファイルの順番は未指定となります。このリストには、隠しファイルも含め、指定されたディレクトリ内のすべてのJARファイルが含まれます。*からなるクラスパス・エントリは、カレント・ディレクトリ内のすべてのJARファイルのリストに展開されます。CLASSPATH環境変数も同様に展開されます。クラス・パスのワイルドカード展開は、Java仮想マシン(JVM)の起動前に実行されます。System.getenv ("CLASSPATH")の呼出しなどによって環境を照会しないかぎり、Javaプログラムが展開されていないワイルドカードを認識することはありません。

-doclet class

ドキュメントの生成に使うドックレットを起動するためのクラス・ファイルを指定します。完全修飾名を指定してください。このドックレットにより、出力の内容と形式が定義されます。-docletオプションが使われていない場合、javadocコマンドは、標準ドックレットを使ってデフォルトのHTML形式を生成します。このクラスは、jdk.javadoc.doclet.Docletインタフェースを実装する必要があります。この起動クラスへのパスは、-docletpathオプションによって定義されます。

-docletpath path

-docletオプションで指定されているドックレット開始クラス・ファイル、およびそれが依存するJARファイルへのパスを指定します。開始クラス・ファイルがJARファイル内にある場合、このオプションではそのJARファイルへのパスが指定されます。絶対パスまたは現在のディレクトリからの相対パスを指定できます。目的のドックレット開始クラスがすでに検索パス内にある場合は、このオプションは不要です。

-encoding name

ソース・ファイルのエンコーディングの名前(EUCJIS/SJISなど)を指定します。このオプションが指定されていない場合は、プラットフォームのデフォルト・コンバータが使用されます。

-exclude pkglist

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

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

Oracle Solaris、LinuxおよびmacOS:

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: すべての依存性を含めます。

-extdirs dirlist

インストールされた拡張機能の位置をオーバーライドします。拡張機能クラスとは、Java拡張機能メカニズムを使うすべてのクラスです。extdirsオプションは、javadocコマンドがソース・ファイルとクラス・ファイルを探すときに使う検索パスの一部です。詳細は、-classpathオプションを参照してください。dirlist内で複数のディレクトリを区切るには、Windowsではセミコロン(;)、Oracle Solaris、LinuxおよびmacOSではコロン(:)を使用します。

-helpまたは--help

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

-J flag

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

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

使用しているjavadocコマンドのバージョンを確認するには、-versionオプションを使用します。出力ストリームには標準ドックレットのバージョン番号が含まれます。

--limit-modules module(,module)*

参照可能なモジュールの数を制限します。

-locale name

javadocコマンドがドキュメントを生成するときに使うロケールを指定します。引数は、java.util.Localeドキュメントで説明しているように、en_US (英語、米国)またはen_US_WIN (Windowsバリアント)などのロケールの名前です。

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

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

--module module(,module)*

指定されたモジュールをドキュメント化します。

--module-path pathまたは-p path

アプリケーション・モジュールの参照先を指定します。

アプリケーション・モジュール・パス(--module-pathまたは短縮版の-mp)には、ライブラリおよびアプリケーション・モジュール(すべてのフェーズ)のコンパイル済定義が含まれます。リンク時に、このパスにJava SEおよびJava Development Kit (JDK)モジュールを含めることもできます。

--module-source-path path

複数のモジュールの入力ソース・ファイルの参照先を指定します。--module-source-pathオプションにはソース・フォームのモジュール定義が含まれます(コンパイル時のみ).

-package

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

--patch-module module=file(file*)

モジュール内の引数を、JARファイルまたはディレクトリ内のクラスおよびリソースでオーバーライドします。

注意:

file(:file)*は、--module-pathや--module-source-pathといった他のオプションのpathと同じです。

-private

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

-protected

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

-public

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

-quiet

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

--release release

指定されたリリースとのソース互換性を持たせます。

--show-members value

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

protected

publicおよびprotected宣言を表示します。これはデフォルトです。

public

public値のみを表示します。

package

public、protectedおよびパッケージ宣言を表示します。

private

すべての宣言を表示します。

--show-module-contents value

モジュール宣言の文書粒度を指定します。指定できる値はapiまたはallです。

--show-packages value

どのモジュール・パッケージをドキュメント化するかを指定します。指定できる値はexportedまたはallパッケージです。

--show-types value

どの宣言(フィールドやメソッド)をドキュメント化するかを指定し、valueには次のいずれかを指定できます。

protected

publicおよびprotected宣言を表示します。これはデフォルトです。

public

public値のみを表示します。

package

public、protectedおよびパッケージ宣言を表示します。

private

すべての宣言を表示します。

-source release

受け付けるソース・コードのリリースを指定します。javacコマンドでコードをコンパイルしたときに使用した値に対応するreleaseの値を使用します。最も古いリリースはJDK 6、最新はJDK 9です。

--source-path pathまたは-sourcepath path

javadocコマンドにパッケージ名または-subpackagesオプションを渡すときに、ソース・ファイルを検索するためのパスを指定します。

Oracle Solaris、LinuxおよびmacOS: 複数のパスを区切るには、コロン(:)を使用します。

Windows: 複数のパスを区切るには、セミコロン(;)を使用します。

javadocコマンドは、指定されたパス以下のすべてのサブディレクトリを検索します。このオプションを使用して、ドキュメント化されるソース・ファイルの位置のみでなく、それ自体はドキュメント化されないがドキュメント化されるソース・ファイルから継承されたコメントを持つソース・ファイルの位置も確認できます。

-sourcepathオプションは、javadocコマンドにパッケージ名を渡すときにだけ使用できます。javadocコマンドに渡されるソース・ファイルは、このパスからは検索されません。ソース・ファイルを検索するには、そのファイルのあるディレクトリに移動するか、各ファイルの先頭にパスを含めます。-sourcepathが省略された場合、javadocコマンドは、クラス・パスを使ってソース・ファイルを検索します(-classpathを参照)。デフォルトの-sourcepathは、クラス・パスの値です。-classpathを省略してパッケージ名をjavadocコマンドに渡すと、javadocコマンドは現在のディレクトリおよびそのサブディレクトリからソース・ファイルを検索します。

sourcepathlistには、ドキュメント化するパッケージ名のソース・ツリーのルート・ディレクトリを設定します。

Oracle Solaris、LinuxおよびmacOS:

• たとえば、com.mypackageという名前のパッケージをドキュメント化する場合に、そのソース・ファイルが/home/user/src/com/mypackage/*.javaにあるとします。次のように、sourcepathを/home/user/src (com\mypackageを含むディレクトリ)として指定し、パッケージ名を指定します。

  javadoc -sourcepath /home/user/src/ com.mypackage
  

• sourcepathの値とパッケージ名を連結して、ドットをスラッシュ(/)に変更すると、次のように、パッケージのフル・パスになります。

  /home/user/src/com/mypackage
  

• 2つのソース・パスを設定するには、次のようにします。

  javadoc -sourcepath /home/user1/src:/home/user2/src com.mypackage
  

Windows:

• たとえば、com.mypackageという名前のパッケージをドキュメント化する場合に、そのソース・ファイルが\user\src\com\mypackage\*.javaにあるとします。次のように、sourcepathを\user\src (com\mypackageを含むディレクトリ)として指定し、パッケージ名を指定します。

  javadoc -sourcepath C:\user\src com.mypackage
  

• ソース・パスの値とパッケージ名を連結して、ドットをバックスラッシュ(\)に変えると、パッケージのフル・パスになることに注目してください。

  \user\src\com\mypackage
  

• 2つのソース・パスを設定するには、次のようにします。

  javadoc -sourcepath \user1\src;\user2\src com.mypackage
  

-subpackages subpkglist

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

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

Oracle Solaris、LinuxおよびmacOS:

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

Windows:

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

--system jdk

モジュラ・リリースで使用されるシステム・モジュールの場所をオーバーライドします。

システム・モジュールとは(コンパイル時およびランタイム)環境に組み込まれているコンパイル済モジュールのことです。カスタム・リンクされたイメージの場合は、ライブラリおよびアプリケーション・モジュールを含めることもできます。コンパイル時に、システム・モジュールはシステム・モジュールのロード元のJDKイメージを指定する-systemオプションを使用してオーバーライドできます。

これらのパスに存在するモジュール定義(たとえば--module-source-path path)では、システム・モジュールと一緒に、参照可能なモジュールの数を定義します。モジュール・パスはシーケンスで、その各要素はモジュール定義またはモジュール定義を含むディレクトリのいずれかです。

--upgrade-module-path path

アップグレード可能オプションの場所をオーバーライドします。--upgrade-module-pathオプションには、(コンパイル時およびランタイム)環境に組み込まれているアップグレード可能モジュールのかわりに使用するための、モジュールのコンパイル済定義が含まれます。

-verbose

javadocコマンドの実行中に詳細なメッセージを表示します。verboseオプションを指定しないと、ソース・ファイルのロード時、ドキュメントの生成時(ソース・ファイルごとに1つのメッセージ)、およびソート時にメッセージが表示されます。verboseオプションを指定すると、各Javaソース・ファイルの解析に要した時間(ミリ秒単位)など、追加のメッセージが表示されます。

—X

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

-Xmaxerrs number

印刷するエラーの最大数を設定します。

-Xmaxwarns number

印刷する警告の最大数を設定します。

-Xold

旧式のjavadocツールを呼び出します。

-javafx

標準ドックレットに対してJavaFX拡張機能を使用して、HTMLドキュメントを生成します。生成されたドキュメントには、標準Javaドックレットで生成された他のサマリー・セクションに加えて「プロパティのサマリー」セクションが含まれています。リストされたプロパティは、各プロパティのgetterおよびsetterメソッドのセクションにリンクされます。

getterおよびsetterメソッドに対して明示的に記載されているドキュメント・コメントがない場合、プロパティ・メソッドのドキュメント・コメントがこれらのメソッドに対して生成されたドキュメントに自動的にコピーされます。このオプションは、プロパティのデフォルト値を記述できる新しい@defaultValueタグも追加します。

例:

javadoc -javafx MyClass.java -d testdir

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

-author

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

-bottom text

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

-charset name

このドキュメント用のHTML文字セットを指定します。この名前はIANA Registry, Character Setsで指定されている望ましいMultipurpose Internet Mail Extensions (MIME)名である必要があります。

たとえば、javadoc -charset "iso-8859-1" mypackageを実行すると、生成されるすべてのページの先頭に次の行が挿入されます。

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

このMETAタグについては、HTML standard (4197265 and 4137321), HTML Document Representationを参照してください。

-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 Registry, Character Setsで指定されている望ましいMIME名である必要があります。

-docencodingオプションを省略しながら-encodingオプションを使用した場合、生成されるHTMLファイルのエンコーディングは、-encodingオプションによって決まります。たとえば、javadoc -docencoding "iso-8859-1" mypackageのように使用します。

-docfilessubdirs

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

-doctitle title

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

--excludedocfilessubdir name

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

-footer html-code

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

--frames

生成された出力でのフレームの使用を有効化します(デフォルト)。

-group name p1:p2

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

-group groupheading packagepattern:packagepatternでは、概要ページのパッケージを指定のグループごとに、1つの表に1つのグループになるように分けます。各グループは、それぞれ別の-groupオプションで指定します。これらのグループは、コマンド行で指定した順序でページに表示されます。各グループ内では、パッケージがアルファベット順に並べられます。指定した-groupオプションごとに、packagepattern式のリストと一致するパッケージが、見出しgroupheadingを持つ1つの表にまとめて表示されます。

• groupheading値には、任意のテキストを指定でき、空白を含めることができます。指定したテキストは、グループの表見出しになります。

• packagepatternの値には、任意のパッケージ名の先頭部分とそれに続く1つのアスタリスク(*)を指定できます。アスタリスクは使用できる唯一のワイルドカードであり、任意の文字に一致するという意味です。1つのグループには、コロン(:)で区切って複数のパターンを含めることができます。パターンやパターン・リスト内でアスタリスクを使う場合は、"java.lang*:java.util"のように、パターン・リストを引用符で囲む必要があります。

-groupオプションが指定されていない場合は、すべてのパッケージが、「パッケージ」という見出しおよび適切な小見出しの1つのグループに入れられます。ドキュメント化されるパッケージの中に、指定したどの小見出しにも入らないパッケージがある場合、このようなパッケージは「その他のパッケージ」という小見出しを持つ独立したグループに入れられます。

たとえば、次のjavadocコマンドでは、ドキュメント化される3つのパッケージは、Core、Extension、およびOther Packagesに分けられます。java.lang*には末尾のドット(.)がありません。java.lang.*のようにドットを入れると、 java.langパッケージは除外されることになります。

javadoc -group "Core Packages" "java.lang*:java.util"
        -group "Extension Packages" "javax.*"
        java.lang java.lang.reflect java.util javax.servlet java.new

コア・パッケージ

java.lang

java.lang.reflect

java.util

拡張機能パッケージ

javax.servlet

その他のパッケージ

java.new

-header header

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

-helpfile path\filename

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

Oracle Solaris、LinuxおよびmacOS:

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

Windows:

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

-html4

HTML4.0.1出力を生成します。

-html5

HTML5出力を生成します。HTML5によりWebページのセマンティック度が高まり、利用しやすいWebページの作成が容易になります。

注意:

-html4と-html5のいずれのオプションも、ドキュメント・コメント内のHTMLは同じバージョン(4または5)であると見なします。いずれのオプションも指定しない場合は、デフォルトでHTML4出力が生成されます。標準ドックレットは、ユーザー・ドキュメント・コメント内のHTMLを指定された出力バージョンに変換することはしません。

-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により生成された既存の外部参照クラスのドキュメンテーションへのリンクを作成します。extdocURL引数は、リンク先として指定する、Javadocにより生成された外部ドキュメントを含むディレクトリの絶対URLまたは相対URLです。javadocコマンドの実行時に複数の-linkオプションを指定して、複数のドキュメントへのリンクを作成することもできます。

このディレクトリ内にpackage-listファイルが存在する必要があります(存在しない場合は、-linkofflineオプションを使用します)。javadocコマンドはpackage-listファイルからパッケージ名を読み取り、これらのパッケージをそのURLにリンクします。javadocコマンドを実行すると、作成される<A HREF>リンク内にextdocURLの値がコピーされます。したがって、extdocURLはファイルへのURLではなくディレクトリへのURLでなければなりません。extdocURLへの絶対リンクを使用すると、ユーザーのドキュメントを任意のWebサイト上のドキュメントにリンクできます。相対位置へリンクするだけでよい場合は相対リンクを使用できます。相対リンクを使用する場合、ユーザーが渡す値は、生成先ディレクトリ(-dオプションで指定)からリンク先となるパッケージを含むディレクトリへの相対パスにする必要があります。絶対リンクを指定する場合は通常、HTTPリンクを使用します。Webサーバーを持たないファイル・システムにリンクする場合は、ファイル・リンクを使用できます。生成されたドキュメントにアクセスするすべての人が同じファイル・システムを共有している場合にのみファイル・リンクを使用します。いずれの場合も、そしてすべてのオペレーティング・システムにおいて、URLが絶対か相対か、およびhttp:かfile:かにかかわらず、URL Memo: Uniform Resource Locatorsで指定されているとおりにセパレータとしてスラッシュを使用します。

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

linkオプションの使用を参照してください。

-linkoffline url1 url2

-linkオプションのバリエーションを提供します。どちらも、Javadocによって生成された外部参照クラスのドキュメントへのリンクを作成します。javadocコマンドがWeb接続を使ってドキュメントにアクセスできないとき、Web上のドキュメントにリンクするには、-linkofflineオプションを使用します。外部ドキュメントのpackage-listファイルにアクセスできないとき、またはこのファイルがurlで指定された場所とは異なる場所(通常、packageListLocで指定可能なローカルな場所)に存在するとき、-linkofflineオプションを使用します。url1にWorld Wide Web上でしかアクセスできない場合は、-linkofflineオプションを指定することにより、ドキュメントの生成時にjavadocコマンドがWebに接続できなければならないという制約がなくなります。さらに、ドキュメントを更新するためのワークアラウンドとしての使用も可能です。パッケージのセット全体に対してjavadocコマンドを実行した後、変更した一部のパッケージに対して再度javadocコマンドを実行できます。こうして、更新されたファイルを、オリジナルのファイル・セットに挿入できるようにします。-linkofflineオプションは引数を2つ取ります。最初の引数は<a href>リンクに組み込まれる文字列を指定する引数、2番目の引数は-linkofflineオプションに対してpackage-listファイルの検索場所を指定する引数です。

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

linkofflineオプションの使用を参照してください。

-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()

-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 all |packagename1:packagename2...

出力されるクラス名から修飾パッケージ名を省略します。-noqualifierオプションの引数としてallを指定した場合、すべてのパッケージ修飾子が省略されます。削除するパッケージ修飾子をコロン区切りリストやワイルドカードで指定することもできます。クラスまたはインタフェースの名前が表示される場所からパッケージ名が削除されます。

次の例では、すべてのパッケージ修飾子を省略します。-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コマンドのリリース番号が含まれており、現在は次のようになります。<!-- Generated by javadoc (build 1.5.0_01) on Thu Apr 02 14:04:52 IST 2009 -->

-notree

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

-overview filename

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

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

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

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

javadocコマンドの実行例を参照してください。

filenameで指定するファイルについては、ソース・ファイルの「概要コメント・ファイル」を参照してください。

概要ページが作成されるのは、javadocコマンドに複数のパッケージ名を渡した場合だけです。詳細は、生成されるファイルの「HTMLフレーム」を参照してください。概要ページのタイトルは、-doctitleによって設定されます。

-serialwarn

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

-sourcetab tablength

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

-splitindex

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

-stylesheet filename

代替HTMLスタイルシート・ファイルのパスを指定します。このオプションが指定されていない場合、javadocコマンドは、javadocコマンド内にコード化されているスタイルシート・ファイルstylesheet.cssを自動的に作成します。このオプションを使うと、そのデフォルトの動作をオーバーライドできます。ファイル名には任意の名前を指定でき、stylesheet.cssには限定されません。次に例を示します。

Oracle Solaris、LinuxおよびmacOS:

javadoc -stylesheet file /home/user/mystylesheet.css com.mypackage

Windows:

javadoc -stylesheet file C:\user\mystylesheet.css com.mypackage

-tag tagname :Xaoptcmf:"taghead"

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

タグ・オプションの使用を参照してください。

-taglet class

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

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

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

-use

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

-version

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

-windowtitle title

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

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

標準ドックレットは、基本内容、相互参照、およびサポートのページを生成します。各HTMLページは個別のファイルに相当します。javadocコマンドは2種類のファイルを生成します。最初の種類には、クラスやインタフェースにちなんだ名前が付けられます。2番目の種類には、最初の種類のファイルと競合しないように、ハイフンが含まれています(package-summary.htmlなど)。

基本内容ページ

• ドキュメント化するクラスまたはインタフェースごとに1つのクラス・ページまたはインタフェース・ページ(classname.html)。

• ドキュメント化するパッケージごとに1つのパッケージ・ページ(package-summary.html)。javadocコマンドは、ソース・ツリーのpackageディレクトリ内にpackage.htmlまたはpackage-info.javaというファイルがあれば、その中のHTMLテキストをこのページに組み入れます。

• パッケージのセット全体に対して1つの概要ページ(overview-summary.html)。概要ページは、生成ドキュメントの先頭ページになります。javadocコマンドは、-overviewオプションで指定されたファイル内のHTMLテキストをこのページに組み入れます。概要ページが作成されるのは、javadocコマンドに複数のパッケージ名を渡した場合のみです。HTMLフレームおよびJavadocドックレットのオプションを参照してください。

相互参照ページ

• パッケージのセット全体に対して1つのクラス階層ページ(overview-tree.html)。階層ページを表示するには、ナビゲーション・バーの「概要」をクリックしてから、「階層ツリー」をクリックします。

• 各パッケージに対して1つのクラス階層ページ(package-tree.html)。特定のパッケージ、クラス、またはインタフェースのページを表示してから、「階層ツリー」をクリックすると、そのパッケージのクラス階層が表示されます。

• パッケージごとに1つの「使用」ページ(package-use.html)と、クラスおよびインタフェースごとに1つの「使用」ページ(class-use/classname.html)。「使用」ページには、指定されたクラス、インタフェース、またはパッケージの一部を使っているパッケージ、クラス、メソッド、コンストラクタ、およびフィールドについて記述されます。たとえば、クラスまたはインタフェースAを例にすると、その使用ページには、Aのサブクラス、Aとして宣言されたフィールド、Aを返すメソッド、A型のパラメータを持つメソッドおよびコンストラクタが組み込まれます。「使用」ページを表示するには、そのパッケージ、クラスまたはインタフェースに移動し、ナビゲーション・バーの「使用」リンクをクリックしてください。

• 非推奨APIページ(deprecated-list.html)。すべての非推奨APIおよびそれに代わる推奨APIが一覧表示されます。非推奨APIは、将来の実装では削除される可能性があるため、使用しないようにしてください。

  定数フィールド値ページ(constant-values.html)。staticフィールドの値用です。

• 直列化された形式ページ(serialized-form.html)。直列化および外部化可能なクラスに関する情報を、フィールドとメソッドの説明とともに提供します。このページの情報は、APIを使う開発者ではなく、再実装を行う開発者に必要な情報です。直列化された形式ページへアクセスするには、直列化されたクラスに移動して、そのクラス・コメントにある「関連項目」セクションで「直列化された形式」をクリックします。標準ドックレットは直列化された形式ページを生成します。このページには、Serializableを実装するすべてのクラス(publicまたは非public)が、そのreadObjectやwriteObjectメソッド、直列化されたフィールド、および@serial、@serialField、@serialDataタグからのドキュメンテーション・コメントとともにリストされます。publicのSerializableクラスを除外するには、そのクラスまたはそのクラスが属するパッケージを@serial excludeタグで指定します。package-privateのSerializableクラスを含めるには、そのクラスまたはそのクラスが属するパッケージを@serial includeタグで指定します。-privateオプションの指定なしでjavadocコマンドを実行することにより、publicクラスおよびprivateクラスの完全に直列化された形式を生成できます。Javadocドックレットのオプションを参照してください。

• 索引ページ(index-*.html)。すべてのクラス名、インタフェース名、コンストラクタ名、フィールド名、およびメソッド名が、アルファベット順に並んでいます。索引ページは、Unicodeを扱えるように国際化されています。1つのファイルとして生成することも、先頭文字(英語の場合A–Z)ごとに別々のファイルとして生成することもできます。

サポート・ページ

• ヘルプ・ページ(help-doc.html)。ナビゲーション・バーや前述の各ページに関する説明が記載されています。-helpfileを使うと、デフォルトのヘルプ・ファイルを独自のカスタム・ヘルプ・ファイルでオーバーライドできます。

• 表示用のHTMLフレームを作成する1つのindex.htmlファイル。このファイルは、フレーム付きの先頭ページを表示する場合にロードします。index.htmlファイルには、テキスト・コンテンツは含まれていません。

• いくつかのフレーム・ファイル(*-frame.html)。パッケージ、クラス、およびインタフェースのリストが含まれています。フレーム・ファイルはHTMLフレームを表示します。

• package-listファイル。-linkオプションおよび-linkofflineオプションで使用されます。パッケージ・リスト・ファイルはテキスト・ファイルであり、リンクからはアクセスできません。

• スタイルシート・ファイル(stylesheet.css)。生成されるページの一部の要素について色、フォント・ファミリ、フォント・サイズ、フォント・スタイル、および配置を制御します。

• doc-filesディレクトリ。宛先ディレクトリにコピーするイメージ、サンプル・コード、ソース・コードなどのファイルが格納されます。これらのファイルは、javadocコマンドによって処理されません。このディレクトリは、ソース・ツリーの中にある場合にのみ処理されます。

Javadocドックレットのオプションを参照してください。

HTMLフレーム

javadocコマンドは、コマンドに渡された値に応じて、最低限必要な数(2つまたは3つ)のフレームを作成します。単一のパッケージ名、または単一のパッケージに属するソース・ファイルを引数としてjavadocコマンドに渡した場合、パッケージの一覧は省略されます。かわりに、javadocコマンドは、左側の列にクラスの一覧を表示するフレームを1つ作成します。javadocコマンドに複数のパッケージ名を渡した場合は、概要ページ(overview-summary.html)に加えて、すべてのパッケージを一覧表示する第3のフレームが作成されます。HTMLフレームはデフォルトで有効にされていますが、--no-framesオプションにより無効にできます。フレームを省略するには、「フレームなし」リンクをクリックするか、overview-summary.htmlページからページ・セットを表示します。Javadocの検索機能により、画面スペースのナビゲートと保存がしやすくなります。

生成されるファイルの構造

生成されるクラス・ファイルおよびインタフェース・ファイルは、Javaソース・ファイルおよびクラス・ファイルと同じディレクトリ階層に編成されます。1つのサブパッケージにつき1つのディレクトリ、という構造になります。

Oracle Solaris、LinuxおよびmacOS: たとえば、java.math.BigDecimalクラスに対して生成されたドキュメントはjava/math/BigDecimal.htmlに格納されます。

Windows: たとえば、java.math.BigDecimalクラスに対して生成されたドキュメントはjava\math\BigDecimal.htmlに格納されます。

生成先のディレクトリの名前がapidocsだとすると、java.mathパッケージのファイル構造は下記のようになります。前述のように、frameという語を名前に含むファイルは、すべて左上または左下のフレームに表示されます。それ以外のHTMLファイルは、すべて右側のフレームに表示されます。

ディレクトリは太字です。アスタリスク(*)は、javadocコマンドへの引数がパッケージ名ではなくソース・ファイル名である場合に省略されるファイルおよびディレクトリを示しています。引数がソース・ファイル名の場合は、空のパッケージ・リストが作成されます。doc-filesディレクトリは、ソース・ツリー内に存在する場合にのみ、生成先に作成されます。

生成されるAPI宣言

javadocコマンドは、それぞれのクラス、インタフェース、フィールド、コンストラクタ、およびメソッドの説明の最初に、そのAPI用の宣言を生成します。たとえば、Booleanクラスの宣言は、次のようになります。

public final class Boolean
extends Object
implements Serializable

Boolean.valueOfメソッドの宣言は、次のようになります。

public static Boolean valueOf(String s)

javadocコマンドは、修飾子public、protected、private、abstract、final、static、transient、およびvolatileを組み込むことができますが、synchronizedとnativeを組み込むことができません。synchronizedおよびnative修飾子は、実装の詳細と見なされているため、API仕様には含まれません。

A single enumeration cannot be used by multiple threads concurrently.