【Doxygen】設定ファイルの作成〜ドキュメント作成までの流れ

Doxygenで設定ファイルの作成からドキュメント作成までの流れについて紹介します。

Doxygenでドキュメントを生成するまでの基本的な流れ

下記のようなプロジェクトフォルダ（mylib）を例に、ドキュメントを生成します。

mylib
 + CMakeLists.txt
 + src
 |  + sample.cpp
 |  +   ...
 + include
 |  + sample.h
 |  +   ...

① プロジェクトフォルダ（mylib）に移動し、「mkdir doc」コマンドなどでdocディレクトリを作成します。

mylib
 + CMakeLists.txt
 + src
 |  + sample.cpp
 |  +   ...
 + include
 |  + sample.h
 |  +   ...
 + doc   ← 追加

② docディレクトリに移動し、「doxygen -g」コマンドでdoxygenの設定ファイルを作成します。

$ cd doc
$ doxygen -g

③ docディレクトリ内に生成されたDoxyfileを開き、適宜設定を変更します。
以下に設定例を載せます。

場所	パラメータ	説明
035行	PROJECT_NAME = “mylib”	プロジェクト名
095行	OUTPUT_LANGUAGE = Japanese
774行	INPUT = ../	doxygenに読み込ませるディレクトリを指定（例の場合はmylib）
805行	RECURSIVE = YES	サブディレクトリを管理対象に含めるかどうか（ライブラリなら普通含めるのでYES）

④ Doxyfileのあるディレクトリで下記コマンドを実行するとドキュメントが作成されます。

$ doxygen