ようこそ ゲスト さん、新規登録(無料)して気になる疑問を解決しませんか?

質問

QNo.3961339 Doxygenでソースコード内のコメントが生成ドキュメントに反映されない
質問者:kotaro1203 質問させていただきます。

C++で書いたソースコードをDoxygen(v1.5.5)にかけて、RTF形式のドキュメントを自動生成しようとしています。そこで何点か問題が出てきました。
1.生成されたドキュメントを見ると、ソースコード内に記述したコメントが何一つ反映されていません。ヘッダに書いた関数コメントは反映されています。コメントは//! で記述しており、Doxygenのルールに従っています。
2.図が入っていません。graphviz→Doxygenの順にインストールしており、Doxygenが認識していない、ということはないと思うのですが。
3.日本語が文字化けしています。エディタは秀丸を使用しており、保存時にエンコードをUTF8にすれば、文字化けしないのですが、いちいち不便です。

ご存知の方、何卒お助け下さい。
困り度:
  • 困っています
質問投稿日時:
08/04/20 02:03
この質問に対する回答は締め切られました。

回答良回答10pt

ANo.1 1.関数内は対象外というのは、そういうものなのでは?
 少なくとも私はそう認識して使ってました。
2.Doxygenのインストールって、Graphviz自動認識しますっけ。
 少なくとも、Doxyfile(Doxygenの設定ファイル)で、
 Graphvizを使うことと、対象の図を表示することが
 指定されていないと図は出ませんが、どうなっていますか。
 後は、RTFの問題でないか、HTMLでもはいてみて確認する。
 RFCの確認手段によっては、(生成されているが)
画像を生めたRTFがうまく表示できないケースもありえますが。
3.エンコードの設定もDoxyfileにあったはずなので、
 たとえばSJISでソースを書いているのならば、
 SJISで生成すればよいのではないでしょうか。
 # 確かDoxygenの版によってはバグってるのがあったような…。
回答者:MrBan
種類:アドバイス
どんな人:経験者
自信:自信あり
回答日時:
08/04/20 06:44
この回答への補足Doxygenのバージョンをv1.5.1にして確認しました。
結果、
・ソースコード内に記述したコメントが生成されたドキュメントに反映されました。
・SJISのソースから文字化けすることなく、ドキュメントが生成されました。
Doxyfileに手は入れていません。

ただ、相変わらずクラス図が作成されていない状況です。GraphvizのEXEを直にDoxyfile中でDOTに指定したのですが、、、
すみませんが、情報お持ちでしたら宜しくお願い致します。
この回答へのお礼回答ありがとうございます。

>1.関数内は対象外というのは、そういうものなのでは?
たしか、コード内でも//!でドキュメント化されると思っていました。
あれ?されないのでしたっけ?
>2.Doxygenのインストールって、Graphviz自動認識しますっけ。
下記からの情報になります。HTMLではどうなるかは、確認してみます。
http://skazami.web.infoseek.co.jp/tools/Graphviz_Doxygen.htm
>3.エンコードの設定もDoxyfileにあったはずなので、
>たとえばSJISでソースを書いているのならば、
> SJISで生成すればよいのではないでしょうか。
はい、SJISで生成したいのですが、INPUT_FILTERに何を指定すればよいのかがわかりませんでした。サイトによっては"nkf --sjis"とする、と書いてあるところもあるのですが、結果、文字化けどころか、ほとんど空っぽのドキュメントが生成されてしまいました。