「-help」オプション

広告

「-help」オプションはオンラインヘルプを表示します。javadocコマンドの使い方とオプションの説明が表示されます。

次のように実行して下さい。

javadoc -help

実行結果は次のように表示されます。

C:¥javadoc>javadoc -help
使用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview <file>          HTML ファイルから概要ドキュメントを読み込む
-public                   public クラスとメンバのみを示す
-protected                protected/public クラスとメンバを示す (デフォルト)
-package                  package/protected/public クラスとメンバを示す
-private                  すべてのクラスとメンバを示す
-help                     コマンド行オプションを表示して終了する
-doclet <class>           代替 doclet を介して出力を生成する
-docletpath <path>        doclet クラスファイルを探す場所を指定する
-sourcepath <pathlist>    ソースファイルのある場所を指定する
-classpath <pathlist>     ユーザクラスファイルのある場所を指定する
-exclude <pkglist>        除外するパッケージリストを指定する
-subpackages <subpkglist> 再帰的にロードするサブパッケージを指定する
-breakiterator            BreakIterator で最初の文を計算する
-bootclasspath <pathlist> ブートストラップクラスローダによりロードされた
                          クラスファイルの位置をオーバーライドする
-source <release>         指定されたリリースとソースの互換性が提供される
-extdirs <dirlist>        拡張機能がインストールされた位置をオーバーライドする
-verbose                  Javadoc の動作についてメッセージを出力する
-locale <name>            en_US や en_US_WIN などの使用するロケール
-encoding <name>          ソースファイルのエンコーディング名
-quiet                    状態メッセージを表示しない
-J<flag>                  <flag> を実行システムに直接渡す

標準の doclet により提供されるもの:
-d <directory>                    出力ファイルの転送先ディレクトリ
-use                              クラスとパッケージの使用ページを作成する
-version                          @version パラグラフを含める
-author                           @author パラグラフを含める
-docfilessubdirs                  doc-file サブディレクトリを再帰的にコピーする
-splitindex                       1 字ごとに 1 ファイルに索引を分割する
-windowtitle <text>               ドキュメント用のブラウザウィンドウタイトル
-doctitle <html-code>             概要ページにタイトルを含める
-header <html-code>               各ページにヘッダーを含める
-footer <html-code>               各ページにフッターを含める
-top    <html-code>               各ページに上部テキストを含める
-bottom <html-code>               各ページに下部テキストを含める
-link <url>                       <url> に javadoc 出力へのリンクを作成する
-linkoffline <url> <url2>         <url2> にあるパッケージリストを使用して <url>
の docs にリンクする
-excludedocfilessubdir <name1>:.. 指定された名前の doc-files サブディレクトリを
すべて除外する
-group <name> <p1>:<p2>..         指定するパッケージを概要ページにおいてグループ
化する
-nocomment                        記述およびタグを抑制して宣言だけを生成する
-nodeprecated                     @deprecated 情報を除外する
-noqualifier <name1>:<name2>:...  出力から修飾子のリストを除外する
-nosince                          @since 情報を除外する
-notimestamp                      非表示のタイムスタンプを除外する
-nodeprecatedlist                 非推奨 のリストを生成しない
-notree                           クラス階層を生成しない
-noindex                          索引を生成しない
-nohelp                           ヘルプリンクを生成しない
-nonavbar                         ナビゲーションバーを生成しない
-serialwarn                       @serial タグに関する警告を生成する
-tag <name>:<locations>:<header>  単一の引数を持つカスタムタグを指定する
-taglet                           タグレットの完全修飾名を登録する
-tagletpath                       タグレットのパス
-charset <charset>                生成されるドキュメントのクロスプラットフォーム
での文字エンコーディング
-helpfile <file>                  ヘルプリンクのリンク先ファイルを含める
-linksource                       HTML 形式でソースを生成する
-sourcetab <tab length>           ソース内のタブの空白文字の数を指定する
-keywords                         HTML の meta タグに、パッケージ、クラス、およ
びメンバーの情報を含める
-stylesheetfile <path>            生成されたドキュメントのスタイル変更用ファイル

-docencoding <name>               出力エンコーディング名

C:¥javadoc>

( Written by Tatsuo Ikura )

関連記事 (一部広告含む)