Doxygen の基本的な使い方と初期設定

更新: 2009-06-09 / 作成: 2009-06-09

コマンド

設定ファイル Doxyfile を作成する

$ doxygen -g

次のように -s オプションを付けて生成すれば、最小限のコメントを含んだ Doxyfile を生成できます。

$ doxygen -s -g

ドキュメントを生成する

$ doxygen [configName]

※設定ファイル名を省略した場合は、Doxyfile が使用されます。

プロジェクト名を指定

PROJECT_NAME = MyProject

HTML 形式のドキュメントだけを作成するように設定

GENERATE_HTML  = YES
GENERATE_CHI   = NO
GENERATE_LATEX = NO  ※これがデフォルトで YES になってる
GENERATE_RTF   = NO
GENERATE_MAN   = NO

HTML 出力形式の設定

SOURCE_BROWSER = YES  # Files tab includes *.cpp files.
GENERATE_TREEVIEW = YES  # A side panel will be generated.

doxygen コマンド実行時に warning 以外の出力を抑制する

QUIET    = NO
WARNINGS = YES

下位ディレクトリも処理

RECURSIVE = YES