doxygen使用手順

■インストール
http://www.fides.dti.ne.jp/~oka-t/doxygen.html#install

とかでよくね?
試してないからわからんけど。
■設定ファイルの生成
カレントディレクトリをソースコードの存在するディレクトリに移動。

$ doxygen -g

カレントディレクトリにDoxyfileが生成される。
■設定ファイルの修正

$ vi Doxyfile

お勧めの設定
INPUTにカレントディレクトリのフルパスを設定(ルートを設定したことになる)

例:INPUT = /home/tappe/hoge

RECURSIVEをYESに変更し、再帰的にディレクトリを検索するように設定

例:RECURSIVE = YES

EXCLUDEで除外したいディレクトリをフルパスで指定(相対で指定する方法あるのかな・・・・?)

例:EXCLUDE = /home/tappe/hoge/test
              /home/tappe/hoge/meso
↑/home/tappe/hoge/testと/home/tappe/hoge/mesoが除外される

パターンで除外させたいときはEXCLUDE_PATTERNSも併用する。
GENARATE_LATEXでLATEXの出力をやめる(今のところいらないので)

例:GENARATE_LATEX = NO

詳しくは↓で
http://www.doxygen.jp/starting.html
■doxygenの実行

$ doxygen Doxyfile

カレントディレクトリにhtmlディレクトリが生成され、その中になんかドキュメントができる。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です