読者です 読者をやめる 読者になる 読者になる

きょこみのーと

元六本木でGo書いてました。今はVRでGo書いてます。

Macにdoxygenいれてみた

超簡単。

f:id:kyokomi:20140504150748p:plain

インストール

Homebrewで入れます。なんでもあるなー

$ brew install doxygen

準備

Doxyfile作成

doxygen作りたいプロジェクトの直下へ移動して、 doxygen -gを実行するとDoxyfileが作られる。

doxygenの設定ファイル的なやつ。

$ doxygen -g

再帰的な設定

デフォルトだとカレントディレクトリしかソース探してくれないっぽいので、 再帰的にする。

Doxyfileをviとかで開いて編集。

とりあえず1箇所だけ。

RECURSIVEYESにすると再帰的にディレクトリ探してくれる。

RECURSIVE = YES

実行する

$ doxygen

実行したディレクトリの直下にhtmlってディレクトリが作成されるので、 そこにあるindex.htmlをブラウザで開くだけドキュメントがそこに!

ちゃんとdoxygenのルールにそってコメントをつけておけばいい感じなるみたいですね。 Cocos2d-xでデフォルトで作られるソースは、doxygenなのでそれ参考にしてもいいかと。

あとは公式ですね。

http://www.doxygen.jp/docblocks.html

そこまでトリッキーなコメント書かなくてよさそうなので、 今後は、doxygen公式とか参考にしてdoxygen用のコメント書く癖つけておくと幸せになれそうですね。