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
オプションと同等です。これらのオプションの使用方法の詳細は、「標準オプション」を参照してください。
-
--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>
など)が続くピリオドで停止します。 -
ブレークイテレータ文区切りアルゴリズム — 次の語が大文字で始まる場合、空白文字が続くピリオド、疑問符、または感嘆符で停止します。このアルゴリズムでは、ほとんどの省略表記が処理されます(「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および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
: すべての依存性を含めます。
-
-
-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
ツールがドキュメントを生成するときに使用するロケールを指定します。引数は、java.util.Locale
ドキュメントで説明しているように、en_US
(英語、米国)またはen_US_WIN
(Windowsバリアント)などのロケールの名前です。ノート:
-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およびprotectedタイプを表示します。 -
public
: public値のみを表示します。 -
package
: public、protectedおよびpackageタイプを表示します。 -
private
: すべてのタイプを表示します。
-
-
-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
-
-
-verbose
-
javadoc
ツールの実行中に詳細なメッセージを表示します。-verbose
オプションを指定しないと、ソース・ファイルのロード時、ドキュメントの生成時(ソース・ファイルごとに1つのメッセージ)、およびソート時にメッセージが表示されます。-verbose
オプションを指定すると、各Javaソース・ファイルの解析に要した時間(ミリ秒単位)を示す追加のメッセージが表示されます。 -
--version
-
バージョン情報を出力します。
拡張オプション
ノート:
javadoc
の拡張オプションは、予告なく変更される可能性があります。
javadoc
の拡張オプションは、対応するjavac
オプションと同等です。これらのオプションの使用方法の詳細は、javac
の「追加オプション」を参照してください。
-
--add-exports
-
--add-reads
-
--patch-module
-
-Xmaxerrs
-
-Xmaxwarns
次のjavadoc
の拡張オプションは、対応するjavac
オプションと異なります。
標準ドックレットのオプション
次のオプションは、標準ドックレットによって提供されます。
-
--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 Registry, Character Setsで指定されている望ましい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およびmacOS: たとえば、次のコマンドでは、
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名である必要があります。
javadoc
エンコーディング・コマンドで使用できるオプションは3つあります。-encoding
オプションはjavadoc
ツールによって読み取られるファイルのエンコーディングに使用され、-docencoding
および-charset
オプションはツールによって書き込まれるファイルのエンコーディングに使用されます。使用可能な3つのオプションのうち、1つのエンコーディング・コマンドで使用できるのは、最大でも入力エンコーディング・オプションと1つの出力エンコーディング・オプションのみです。入力エンコーディング・オプションと出力エンコーディング・オプションの両方を1つのコマンドで指定する場合は、それらを同じ値にする必要があります。いずれの出力オプションも指定しなかった場合、ツールによってデフォルトで入力エンコーディングに設定されます。たとえば:
javadoc -docencoding "iso-8859-1" mypackage
-
-docfilessubdirs
-
再帰的にdoc-fileサブディレクトリをコピーしますdoc-filesディレクトリの深いコピーを有効にします。コピー先には、サブディレクトリとすべての内容が再帰的にコピーされます。たとえば、ディレクトリ
doc-files/example/images
とその内容がすべてコピーされます。-excludedocfilessubdir
オプションを使用すると、特定のサブディレクトリを除外できます。 -
-doctitle html-code
-
概要ファイルの最上部の近くに配置するタイトルを指定します。
title
タグに指定されたテキストは中央揃えになり、レベル1の見出しとして、上部ナビゲーション・バーのすぐ下に置かれます。title
タグには、HTMLタグと空白を含めることができますが、これらを含める場合は、タイトルを引用符で囲まなければなりません。title
タグ内のその他の引用符は、エスケープする必要があります。たとえば、javadoc -header "<b>My Library</b><br>v1.0" com.mypackage
-
-excludedocfilessubdir name1,name2...
-
doc-fileサブディレクトリを再帰的にコピーするときに、指定された名前のサブディレクトリを除外します。
-docfilessubdirs
を参照してください。過去の経緯から、セパレータとして,
のかわりに:
を引数の任意の場所に使用できます。 -
-footer html-code
-
各出力ファイルの下端に配置するフッター・テキストを指定します。
html-code
の値は、下部ナビゲーション・バーの右側に配置されます。html-code
の値には、HTMLタグと空白を含めることができますが、これらを含める場合は、html-code
の値を引用符で囲む必要があります。フッター内の内部引用符には、エスケープ文字を使用してください。 -
--frames
-
生成された出力でのフレームの使用を有効化します(デフォルト)。
-
-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およびmacOS:
javadoc -helpfile /home/user/myhelp.html java.awt.
-
Windows:
javadoc -helpfile C:\user\myhelp.html java.awt.
-
-
-html4
-
HTML 4.0.1出力を生成します。デフォルトはHTML 5出力です。
-
-html5
-
HTML 5出力を生成します(デフォルト)。
-
--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つのソース・ベースで実行し、両者間の差分を取得する場合、-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およびmacOS: たとえば、
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
値を省略すると、tagname
が見出しとして表示されます。 -
-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
で置換します。