TIPS Doxygenの導入

事前準備

1. Homebrewをインストールする。

$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew -v

2. DoxygenとGraphvizをインストールする。

$ brew install doxygen
$ brew install graphviz

使い方

1. 設定ファイルを出力

$ doxygen -g

2. 設定を変えたい場合は、Doxyfileを変更する。

デフォルトでOFFになっているもののONにした方がよいと考えられる主なオプションは以下の通りです

option	default	description
PROJECT_NAME	"My Project"	クラス図を作成したいプロジェクトの名前
EXTRACT_PRIVATE	NO	privateなメンバ変数・メンバ関数も出力する
EXTRACT_STATIC	NO	staticなメンバ変数・メンバ関数も出力する
EXTRACT_ANON_NSPACES	NO	匿名の名前空間についても出力する
RECURSIVE	NO	ソースコードを再帰的に検索する
HAVE_DOT	NO	YESに設定するとgraphvizなどの描画ツールを使用してクラス図を出力する
DOT_NUM_THREAD	0	スレッド数
CALL_GRAPH	NO	関数やメソッドを呼び出す側の依存関係を描画する
CALLER_GRAPH	NO	関数やメソッドを呼び出される側の依存関係を描画する

3. クラス図を出力する。

所定のディレクトリに移動する後、以下のコマンドをうつ

$ doxygen

4. クラス図を確認する。

サブディレクトリのhtml/index.htmlを開く