doxygen

ソースファイルのヘッダに著作権表示などもっとちゃんと書こうかと思い、doxygen形式だとどう書くのが普通かな〜と検索していたが、そもそもdoxygenをインストールしていなかったので、インストールすることにする。
http://www.doxygen.org/
より、doxygenをダウンロードしてインストール。
doxywizardを立ち上げると、以前使ったことのある画面から変わっていた!
どうやら前に見ていた画面はExpartボタンを押すと出てくるみたい。
かわりにWizard画面があって、こちらを使えということだろう。
Wizard画面で適当に入力して出力してみたら見事に文字化け。
Expart画面のProject - OUTPUT_LANGUAGEを「Japanese」にすると文字化けは解消した。
なにかが足りない・・・そうだ、graphvizだ。というわけで、
http://www.graphviz.org/
から、graphvizをダウンロードしてインストール。
http://skazami.web.infoseek.co.jp/tools/Graphviz_Doxygen.htm
を参考に、Build - EXTRACT_ALLのチェックを入れて、Dot - HAVE_DOTのチェックをいれて、DOT_PATHを通すと、無事画像も出た。


doxygenで日本語を扱うときの不具合がすこしあるらしいとのことで、
http://watcher.moe-nifty.com/memo/2005/08/doxygen__7fb8.html
http://watcher.moe-nifty.com/memo/2005/09/doxygen__3_102d.html
文字の2バイト目が「\」の時、たとえば「ソフトウェア」「構造体」が化けるらしいので、これは深刻だと「@param path ソフトウェア」と試しに書いてみたが化けなかった。
DicBook.hに「\defgroup DicBook ソフトウェア」と書いてみたら、確かに「ャtトウェア」に化けた。納得(不具合を見つけて納得というのも変な話だけど)。「@defgroup」でも同じだった。
他にも色々化けるパターンがあるみたいだけど、ソースにパッチ当ててビルドするのも面倒だし、このまま使おう。


日本語サイトを発見。
http://www.doxygen.jp/


JAVADOC_AUTOBRIEFをONにしておくと、@breafを書かなくてもコメントの1行目が勝手に要約になる。ONにするべし。