はじめてのDoxygen

1. Doxyfileのテンプレート作成

[configName] にてconfigファイルのファイル名を指定できるが、指定しなければデフォルトファイル名の "Doxyfile" で作成される。

 

2. Doxyfileの新規作成

[configName] にてonfigファイルのファイル名を指定できるが、指定しなければデフォルトConfigファイル "Doxyfile" が参照される。

自動生成されたテンプレートのDoxyfileを使うと「ほぼ」中身のないドキュメントしか出力されない。

 

3. Doxyfileの編集

3.1. プロジェクト名変更

デフォルトの "My Project" のままで支障はないが気分の問題。

3.2. Doxygen対象ファイルの拡大

デフォルトの NO ではDoxygenが識別可能なタグ(ドキュメント)が埋め込まれたファイル(ソースコード)しか解析対象にならない。

3.3. プライベートメンバーの抽出

プライベートメンバーも抽出する。

3.4. スタティックメンバーの抽出

スタティック(内部スコープ)メンバーも抽出する。

3.5. 再帰読み込み

サブディレクトリの再帰読み込みを有効にする。

3.6. LATEX出力の抑止

LATEX出力が不要(HTML出力で十分)なケースでは NO にする。

3.7. UML形式出力

UMLに準拠した出力形式にする。

3.8. コールグラフ出力

  • CALL_GRAPH : 呼出先関数グラフ(一覧)を出力する。
  • CALLER_GRAPH : 呼出元関数グラフ(一覧)を出力する。

 

4. 特殊コマンド (Special commands)

バックスラッシュ ( \ ) または アットマーク ( @ ) で始まるコマンド。

例. @author, @param, @return, …

Doxygenの多くの特殊コマンドがJavadocと互換性を持っているが、両者は必ずしも共通ではない。