doxygenの正しい使い方(2008年度版)

Powered by dKingyo Qt | C++ | Qt | KDE | VISTA | 画像処理 | Access | TurboGears | Visual C++ | FreeBSD

 OSのソースコード読むならちっちゃいMINIXだろうという事で調べていたら
http://www.aichi-pu.ac.jp/ist/lab/yamamoto/os/src
MINIXソースコードを掲載しているページを発見。


 どうやら、私はソースコードを読むときにはdoxygenの方が慣れているので久々にdoxygenを使うことにした。といっても2年も前のdoxygenなので再インストールすることにした。*1


 そうしたらMSCGENなるツールを指定する項を発見
http://b.hatena.ne.jp/entry/http://www.mcternan.me.uk/mscgen/
関数の呼び出しなどのシーケンス図の出力をするソフトウェアをdoxygenのアドオンとして追加できるらしい。


 それにしてもMINIX…なかなかファイルの出力が終わらない。一体どうしたことか。だが心配ご無用。DoxywizardのStartボタンを押してもなにも画面に変化が無くて焦ってしまうかもしれないが裏ではしっかり動いているので安心して待とう。

 しかし、Doxywizardのdoxygenの出力ログが順次出力されないのには参った。おかげで上手くMSCGENとDOTのパスが上手く設定されていないのにdoxygenをフルで動かしてしまった。これは痛い。

c:\minix>doxygen
Warning: the dot tool could not be found at C:\ProgramFiles\Graphviz2.16\bin\
.exe
Warning: the mscgen tool could not be found at C:\mscgen\mscgen.exe
...
Error opening map file xxxxxxxxxx.map for inclusion in the docs!
...
^C\

よってコマンドプロンプトから実行したほうが良い。

以下のようにダブルクォーテーションで囲ってディレクトリのみを設定しよう。doxygenのVersion 1.5.5 ではこの指定以外doxygenが受け付けてくれないので注意だ。
また、「Error opening map file」は「SHORT_NAMES = YES」とする事で解決するそうだ。*2


MSCGEN_PATH = "C:\mscgen"
DOT_PATH = "C:\Program Files\Graphviz2.16\bin"
SHORT_NAMES = YES

このようにしたDoxyfileをdoxygenにかければ無事に出力してくれるはずだ。



 以上 2008年度版はこれで終わり。


追記:
後に私とほぼ同じ目的でdoxygenを使っている方のレポートを発見。
http://d.hatena.ne.jp/RC3/20080213/1202875298
なるほど。参考になります。

*1:過去にdoxygenをインストールした方法は[searchdiary:doxygenの正しい使い方]を参照してほしい。

*2:via http://blog.so-net.ne.jp/mima_test/2008-01-17-1