Macで Doxygen を使ってドキュメント作成

Doxygen でソースコードをドキュメント化したときのメモ。

■ 参考
- Doxygen公式
- MacでDoxygenとGraphvizを使ってクラス図を出力する

手順

1. Mac に Doxygen と Graphviz をインストール。brew でも、公式URLからダウンロードでも。

2. Doxygen へのPathを通す
   .bash_profile に以下を追加

   export PATH=/Applications/Doxygen.app/Contents/ Resources/:${PATH}
   

3. DoxyFile 作成
   ソースコードの有るフォルダに移動して、以下を実行

   doxygen -g
   

   DoxyFileが生成される。

4. DoxyFile 編集
   必要に応じてDoxyFileを修正。今回自分が修正したのは、以下の通り。

   修正項目	修正前	修正後
   PROJECT_NAME	My Project	<プロジェクトの名前>
   OUTPUT_LANGUAGE	English	Japanese
   CREATE_SUBDIRS	NO	YES
   EXTRACT_ALL	NO	YES
   RECURSIVE	NO	YES
   EXCLUDE		/除きたいディレクトリ （複数あるときは、\ でつなげて書く）
   SOURCE_BROWSER	NO	YES
   HAVE_DOT	NO	YES
   UML_LOOK	NO	YES
   CALL_GRAPH	NO	YES
   CALL_GRAPH	NO	YES
   CALLER_GRAPH	NO	YES

5. doxygen 実行
   ソースコードの有るフォルダにて、以下を実行

   doxygen
   

   htmlフォルダが作成され、Doxygenドキュメントが生成される