Recent changes

2013-04-14 2013-04-02 2013-02-17 2013-01-29 2013-01-20 2013-01-18 2012-12-08 2012-11-06 2012-09-04 2012-08-02

javadoc

<code> 使い方: javadoc [options] [packagenames] [sourcefiles] [classnames] [@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> ソースファイルのエンコーディング名
  • 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> 各ページにフッタを含める
  • 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 情報を除外する
  • nodeprecatedlist 非推奨 API のリストを生成しない
  • notree クラス階層を生成しない
  • noindex 索引を生成しない
  • nohelp ヘルプリンクを生成しない
  • nonavbar ナビゲーションバーを生成しない
  • quiet 画面にステータスメッセージを表示しない
  • serialwarn @serial タグに関する警告を生成する
  • tag <name>:<locations>:<header> 単一の引数を持つカスタムタグを指定する
  • taglet タグレットの完全修飾名を登録する
  • tagletpath タグレットのパス
  • charset <charset> 生成されるドキュメントの文字エンコーディング
  • helpfile <file> ヘルプリンクのリンク先ファイルを含める
  • linksource HTML 形式でソースを生成する
  • stylesheetfile <path> 生成されたドキュメントのスタイル変更用ファイル
  • docencoding <name> 出力エンコーディング名

</code>