Doxygen の使い方

doxygen はコマンドラインベースのユーティリティです。コマンドラインで–help オプションを付けてコールすると、使用方法の要約が表示されます。

すべてのオプションは、-で始まり、次に一文字が続いて、その後オプションに応じてひとつ以上の引数が続きます。

あなたのプロジェクトのマニュアルを生成するには、大抵次の手順を踏んでください。

1. 特殊ドキュメントブロック (セクション 特殊なコメントブロック 参照) を使ってソースコードにドキュメント付けしてください。
2. -g オプションを付けて doxygen をコールして、設定ファイル (セクション config 参照) を生成してください。

   doxygen -g <設定ファイル>
   

3. 設定ファイルを編集してプロジェクトに合った設定にしてください。設定ファイルでは、入力ファイルの他、多くのオプション情報を指定できます。
4. 次のようにdoxygen をコールすると、設定ファイルに指定したオプションに従ってドキュメントが生成されます。

   doxygen <設定ファイル>
   

以前のバージョンの設定ファイルがある場合は、-u オプションを指定してコールすれば、現行バージョンの設定ファイルにアップグレードできます。

doxygen -u <設定ファイル>

もとの設定ファイルの指定は、すべて新しいファイルにコピーされます。新しくできたオプションには初期値が設定されます。ただし、もとのファイルに追加書きされたコメントはコピーされません。

出力の調整

出力結果の見栄えを調整したい場合は、デフォルトのスタイルシート、ヘッダ、フッタのファイルをそれぞれ出力させてください。これらはあとで編集できます。

• HTML形式では、デフォルトのヘッダファイル (HTML_HEADER 参照)、デフォルトのフッタファイル (HTML_FOOTER 参照)、デフォルトのスタイルシート (HTML_STYLESHEET 参照) を、次のようにコールして生成します。

  doxygen -w html header.html footer.html stylesheet.css <設定ファイル>
  

  設定ファイル はオプションです。省略すると、doxygenはDoxyfileというファイルを探し、処理します。それが見つからなければ、デフォルト設定を使います。

• 形式では、refman.tex (LATEX_HEADER と LATEX_FOOTER参照) の最初のパートと、そのヘッダがインクルードするスタイルシート(通常 doxygen.sty) を、次のようにコールして生成します。

  doxygen -w latex header.tex footer.tex doxygen.sty <設定ファイル>
  

  デフォルト以外のオプション (例として、特別な パッケージを使うため) が必要な場合は、オプションを正しく自分で設定ファイルに指定し、その設定ファイルを生成されるファイル名のあとに指定する必要があります(その前に、設定ファイルをバックアップしておいてください。出力ファイルのどれかを指定し忘れると、失うかもしれません)。
• RTF形式では、デフォルトのスタイルシート (RTF_STYLESHEET_FILE 参照) を次のようにして生成します。

  doxygen -w rtf rtfstyle.cfg
  

警告

カスタムヘッダをお使いの場合は、doxygenに必要なスクリプトやスタイルシートを適切にインクルードしてください。これらは、設定オプションに依存し、doxygenがバージョンアップすると変わる可能性があります。

覚え書き

• 設定ファイル内の各要素のコメントが不要な場合は、-s オプションを使ってください。このオプションは、-u オプションと一緒に使え、既存の設定ファイルにコメントを追加したりコメントを削除したりできます。 バグレポートの一部として設定ファイルを私に送る場合、-s オプションでコメントを削除してから送ってください。
• ファイルでなく、標準入力からreadさせたり、標準出力へwriteさせたりする場合は、ファイル名の代わりに - を指定してください。

次 のセクションに行く / インデックス に戻る