Macにdoxygenいれてみた
超簡単。
インストール
Homebrewで入れます。なんでもあるなー
$ brew install doxygen
準備
Doxyfile作成
doxygen作りたいプロジェクトの直下へ移動して、
doxygen -gを実行するとDoxyfileが作られる。
doxygenの設定ファイル的なやつ。
$ doxygen -g
再帰的な設定
デフォルトだとカレントディレクトリしかソース探してくれないっぽいので、 再帰的にする。
Doxyfileをviとかで開いて編集。
とりあえず1箇所だけ。
RECURSIVEをYESにすると再帰的にディレクトリ探してくれる。
RECURSIVE = YES
実行する
$ doxygen
実行したディレクトリの直下にhtmlってディレクトリが作成されるので、
そこにあるindex.htmlをブラウザで開くだけドキュメントがそこに！
ちゃんとdoxygenのルールにそってコメントをつけておけばいい感じなるみたいですね。 Cocos2d-xでデフォルトで作られるソースは、doxygenなのでそれ参考にしてもいいかと。
あとは公式ですね。
http://www.doxygen.jp/docblocks.html
そこまでトリッキーなコメント書かなくてよさそうなので、 今後は、doxygen公式とか参考にしてdoxygen用のコメント書く癖つけておくと幸せになれそうですね。
