Doxygen その他の設定

Doxygen の設定で、幾つか漏れていた部分が有ったので、今回は補足です。


[Expert]タブに Source Brouser という部分が有ります。

ここの設定を変えることで、HTMLからソースコードを確認できるようになります。

まず、いちばん上の SOURCE_BROWSER のチェックを入れてみます。


この部分を変更するとブラウザには、こんな表記が追加されます。


「～の～行目に定義があります。」の部分をクリックすると、

こんな風にソースコードを確認できるようになります。
ただし、ソースコード上には doxygenコマンドの付いたコメントが入っていないことに気が付くかと思います。

SOURCE_BROWSER の２つ下にの STRIP_CODE_COMMENTS にチェックが入っていたと思います。これが原因で、doxygenコマンドの付いたコメントが除去されているのです。
今度は、STRIP_CODE_COMMENTS のチェックを外して確認してみます。




こんな感じでコメントが表示されますが、doxygenコマンドが邪魔ですね・・・。

更に、INLINE_SOURCES のチェックを動作を確認してみます。

とりあえず SOURCE_BROWSER のチェックせずに[Run doxygen]をしてみます。


関数詳解の部分にソースコードがそのまま表示されるようになりました。
SOURCE_BROWSER はソースコードを表示するリンクが作成され、INLINE_SOURCES は、リンクが作成されずソースコードが表示されるみたいです。

どちらかというと、SOURCE_BROWSER の方が無駄が少なくて好みです。
わざわざ.melファイルを開かなくてもコードを確認できるのは中々便利ですね。htmlのサイズは大きくなりますが、付けておいて損はないかも。

この他に変更しておきたいフラグとしては、Build にある SORT_MENBER_DOCS でしょうか。


このチェックを外すと、HTML上のプロシージャの配置が、.melファイル内に記述された順番で並ぶようになります。
初期状態だと、アルファベット順だかで並べ替えられてしまうので、眺めていると、なんか違和感を感じてしまいます。

これで、だいたい自分が設定している部分は終わりでしょうかね。
まだまだフラグとコマンドはたくさんあるので、極めるにはまだまだ掛かるかもしれないですが、頻繁に使うツールでもないので、これ以上進歩はないかもしれないですけどね・・・。