【コメント】doxygen【コンソメ】

無いので建てた

公式
http://www.doxygen.jp/

>>347
それを指摘するのは無粋。つーか、間抜け。

>>347
許容範囲なんだろうけど、ここでは奇怪な書き方をする必要がない、という話。

>3
ttp://stackoverflow.com/questions/165451/suggest-a-good-doxygen-stylesheet
なさそうだね

寧ろ、doxygen.cssをカスタマイズしている人には紹介してほしいなぁ。
ソースを公開しろとまでは言わないから。
後は、こんなのが欲しいなんてリクエストでもあれば創造意欲が沸くかも知れない。

しかしデフォルトのにしておかないと
将来のバージョンアップに毎回追随するのが
結構つらくなるのではと予感。

バージョンアップでかっこよくなったりするし

ttp://www.doxygen.jp/manual.html
このサイト死んだね。

う、うん……(´・ω・｀)

>>354
生き返った。
良かった良かった。

privateなメンバのうち、(純粋)仮想関数だけをドキュメントに出力する方法ってないものでしょうか
EXTRACT_PRIVATE = YESとすると、見せたくないprivate変数や非仮想関数まで出てきてしまうのがイヤで・・・

>>357
そんな状況いままで無かったからな。
初めて考えてみる。

>>340が書いた方式を駆使して
どうにかできそうな気もするが良いアイディアが浮かばない。

Doxygen 1.6.1 をソースパッケージから VC8 でビルドしようとしたのですが src/translator_*.h
が言語毎にいろいろなエンコーディングで保存されていて文字列リテラルの部分でエラーが大量発生する
(おそらく多バイト文字に '\' や '"' が含まれる) のですが、Windows でビルドするときは特別な
手続きがいるのでしょうか？

クラスメソッドの詳細の、“コンストラクタ・デストラクタ”のセクションに
デストラクタが入らないのはdoxygenのバグだよね？
あと、@nameコマンドで１つのクラスに同じ名前のメンバグループを
複数作った場合、それぞれが別のグループとして吐き出されるのは仕様？

あ、どっちも1.6.1の話ね

>>360
> クラスメソッドの詳細の、“コンストラクタ・デストラクタ”のセクションに
> デストラクタが入らないのはdoxygenのバグだよね？
マジで？
試してくる。

>>360
Version 1.6.1 にて出力されたぞ。

出力されないソースないしヘッダの例をうｐしてくれれば確かめるけど？

>>362
ソースはマニュアル内のこのページ(ttp://www.doxygen.jp/docblocks.html)の
サンプルをそのまま使用
本体のバグでないならヘッダの問題かと思い、いろいろ試してみた結果、
INPUT_ENCODING=Shift_JISにした時に問題が起きた(CP932なら問題無し)
ちなみに、出力されないわけじゃなくて、通常の関数と同じセクションに
デストラクタが入ってる

デストラクタ名がチルダでなくオーバーバーで表示されてたので、
doxygenがデストラクタと認識してくれないのが原因か？

>>363
CP932
にしろってオフィシャルでどっかに書いてあったような気がする。
> デストラクタ名がチルダでなくオーバーバーで表示されてたので、
> doxygenがデストラクタと認識してくれないのが原因か？
その可能性が高そうだ。

このQtのマニュアルみたいなのを作りたいのですがdoxygenで作れますか。
http://www.kde.gr.jp/~ichi/qt-2.3.2/annotated.html

>>365
似たようなことはできると思いますが、一致度は保証できません。
TradeMarkとやらで作ったようなことが書かれているので、それでは如何ですか?

>>365-366
Qtのマニュアルは開発元内製の非公開のツールで作られているそうです。
doxygenが作られたのもそれが理由だそうで。
ttp://lists.trolltech.com/qt-interest/2007-07/thread00457-0.html

素敵なcssがほしい。

EXTRACT_PRIVATE = NO の設定で一部の private 関数を文書化する方法はあるでしょうか？
やりたいことは、ある基底クラスに private の仮想関数を定義して (派生クラスでその仮想関数
をオーバーライドするユーザーのために) その関数の仕様を Doxygen で出力することです。

>>369
ちょっと汚いソースになる気もするが、
>>340と同じようにして
Doxygen上にだけprivateをpublicにしちゃえば？

ttp://uploader.rgr.jp/src/up1598.png
このように、ソース中の'が'と表示されてしまうんですが、
対策をご存じの方いらっしゃいますか？
また、他の方がたはこの問題が再現しますか？

サンプルソースは
　ttp://uproda.2ch-library.com/lib200801.zip.shtml
　DLキーはdoxygen
です。
ここのget_widechar.hをDoxygenにかけてhtmlを出力させると
上述の画像のようになります。

html4ではなくxml1の読めるブラウザを使えばいいんでない?
# 根本は解決していないけど。
例えば、IE6がこれに該当するからIE8を入れるとか。
どうしても根本的に解決したいなら、ソースを修正するとか出力を加工するとか。

つーか、手元のソースとDoxygenでは再現しないしzipをダウンロードするのは嫌なんだけど、
再現できる状態でここに貼れる程度に短くできない? それと、Doxygenのバージョンも宜しく。

>>372
確かにIE6で見ていたらだめでしたが、
Firefoxなら正しく表示されました。

ソースは
ttp://codepad.org/7giB9nil
で、Doxygenは1.6.1です。
設定は
DOXYFILE_ENCODING = CP932
OUTPUT_LANGUAGE = Japanese
このぐらいです。

手元の1.5.9じゃ再現できないや。1.6.1持ちか詳しい人待ちだな。

>>374
意外に1.5.9って1.6.1より動作安定してたりしますよね。

ちなみに画像
ttp://uploader.rgr.jp/src/up1598.png
を出力したhtmlファイル（の一部）は
　ttp://codepad.org/OijY25xj
こんな感じで、この中にある
　'
となっている部分を単純に
　'
に置換してしまえば
IE6, Firefoxともに問題無く表示出来る様です。

・・・ってこんな対策でいいのでしょうか？
'を単純に'に置換してしまってまずい場合とかありますでしょうか？

html4.01にはaposがないんだからしょうがないんじゃない?

>>376
俺のところのIE6ってそんな準拠性の悪いクソブラウザだったんですか。
噂には聞いていたんですがねぇ。

ありがとうございました。

Doxygen 1.6.2 age

>>378
まぢすか
入れてきます！

仕様 変わりすぎだよチクショー！！！！！

doxygen.css
の仕様が変わりすぎでございますorz

バージョンが0.01違いなのに、こんなに変わるものだとは。

Doxygenって後方互換性という言葉には興味ないの？

俺以外に
Doxygen 1.6.2
を使ってる人 居ないの？
なんだか、
　1. C++0xが公式仕様策定されて
　2. ちゃんと各種コンパイラで実装されて
　3. 現実的にC++0xを使っても大丈夫だと思うくらいになって
　4. Doxygen がC++0xに対応完了
このくらいの条件を満たさないかぎり、別にアップデートしなくてもいい気がしてきた。
ブラウザとか中核ソフトとは違ってセキュリティもクソもない・・・しね？

>>382
まだ正月休み明けでみなさん忙しいのでは。
私も先ほどようやく試してみたところ。

ざっと見た感じだと、1.6.1 と比べると
>>322 で指摘されていた不具合とか、
friend関数のマニュアルを無視するバグが直ってたりして、
概ね好印象ですね。

>>383
ありがとうございます。

そうですか。
>>324->>324は気付きませんでした。
じゃあやっぱ1.6.2で同じように作れるように自分でどうにか工夫するのが良い
って感じですかね。（私の主体性０）

ちなみに
　Doxyfile 1.6.1 デフォルト
　ttp://codepad.org/olhvPmWM
　Doxyfile 1.6.2 デフォルト
　ttp://codepad.org/wA3SWMYO

1.6.2に更新したら、pageコマンドから作られたhtmlにタイトルが出力されなくなった…
似たような症状の人いる？

>>386
おお！
俺も！俺も！
どうすりゃいいんだろうorz

>>386-387
pageに付ける名前に英数字以外(下線とか)を含まないように、
というようなことがMLに書かれてました。

まじか！
>>388
ありがとうございます。
感謝です。。。

>>388
トンクス！表示されたぜ！

ML見てきたんだが、
>ドキュメントにアンダーバー不許可と明示されてはいないけど、
>名前は英文字と数字の組み合わせからなる、とは書かれていて、
>そこにアンダーバーは含まれていないでしょ。
みたいな返答だった。

でも以前は使えてたわけだし、@page以外のタグは問題ないし、
ドキュメントが更新された形跡もないし、やっぱなんかバグっぽいよね。

>>390
このまま待機で、いつの間にか
(次のverで)修正されるんじゃないかなぁ？

次のverっていつでるんだ。。。

>>391
Bugzilla 見たら、次のバージョンで修正されることになってました。
私も別のバグで次のバージョン待ちです…

＜報告＞
英数字どころか、小文字じゃないとダメみたいです。
AbCdE
とかはだめで、
abcde
ならOKのようです。

死亡回避age

Doxygen Release 1.6.2 + WinXPです。

ttp://codepad.org/UOnh6aUc
これを出力させると
ttp://uploader.rgr.jp/src/up1961.jpg
このように、inlineでもないのに勝手にinlineになります。
なお、
ttp://codepad.org/iT6VHAtw
のように、テンプレートでなければ勝手にinlineにはならないようです。
ttp://uploader.rgr.jp/src/up1962.jpg

同じ症状の方いらっしゃいますか？

あと、もし古いバージョンで試してくださる方がいらっしゃったら
是非結果を教えてください。
よろしくお願い申し上げます。

Graphviz - Graph Visualization Software
が最新版でました！version 2.26.3 になりました。

・・・そしてインストールしたらエラーになったので、
同じ症状で悩んでいる方がもしいらしたら参考にしてください。
解決策のリンク
ttp://old.nabble.com/Dot-problems-td15185555.html


************************************************************************
Oren Almog wrote:
I am using the windows version. Doxygen seems to work fine but I repeatedly
get errors when it calls dot to generate call graphs (or any other graphs).

c0f5d09662a9af0a3f709cb57d6841_cgraph.dot" -Tpng -o
"ex__cmds_8c_abc0f5d09662a9af0a3f709cb57d6841_cgraph.png"'
Problems running dot: exit code=-1, command='dot',

Dot is in my PATH. To be sure I tried to create the graph manually my going
to the directory and calling dot with the same parameters, I get a message
about a missing font and that file will look ugly but the png is generated
with no further input required from me.

Any ideas?
************************************************************************
biljana wrote:
You have to install Graphviz and set the DOT_PATH to the Graphviz/bin folder. Also you should set HAVE_DOT to YES.

Doxygen 1.6.3 age

>>400
ktkr
使います

>>397のバグですが、
Doxygen 1.6.3 で直っていないようです。

バグ報告しないと直らないんですかねぇ。
どこからバグ報告すればいいやら。

Doxygen 1.6.3 で
@pageで生成したページのタイトルが付かないバグ
は、解決しているようですね。

WinXP version1.6.3で、S-JISのファイルを変換したいのですが、設定ファイルを
INPUT_ENCODING = CP932
と設定した場合は、
Error: failed to translate characters from CP932 to UTF-8: check INPUT_ENCODING
とエラーがでます。

INPUT_ENCODING = SHIFT_JIS
とした場合は
Error: failed to translate characters from SHIFT_JIS to UTF-8: check INPUT_ENCODING
とエラーがでます。

DOXYFILE_ENCODING = SHIFT_JIS
として、
PROJECT_NAMEに日本語を設定したら反映されます。

何か他に設定する必要があるのでしょうか？

>>404
INPUT_ENCODING はソースファイルのエンコーディングの設定で、
DOXYFILE_ENCODING は設定ファイル自身のエンコーディングの設定です。

> WinXP version1.6.3で、S-JISのファイルを変換したいのですが、
のS-JISのファイルというのは設定ファイルじゃなくソースファイルのことですか？
だったら、 INPUT_ENCODING = CP932 で合ってるはずなんですが。

S-JISのつもりで実はUnicodeだったなんてことはないですか？

> DOXYFILE_ENCODING = SHIFT_JIS
> として、
> PROJECT_NAMEに日本語を設定したら反映されます。

設定ファイルはDoxywizardを使わないで、テキストエディタで書き換えてるんですか？
Doxywizardだと DOXYFILE_ENCODING は UTF-8 にしないと正しく動作しないはずなので。

>>405

ソースファイルを確認したところ、
新規に追加したものはSHIFT_JISだったのですが、
もともとあったソースは中国語のソースで、文字コードが"繁体字中国語"というもののようで、
このファイルを解析する時に、SHIFT_JISでないということで、エラーになるようです。

ありがとうございました。

中国語か。
最近ちらほら見かける。

こんなの作ってみた。良かったら使ってみて。

つ ttp://sourceforge.jp/projects/sfnet_doxygemplate/
　 ttp://sourceforge.net/projects/doxygemplate/

今のところWindows専用だけど，Qtで作ってるのでLinuxでもビルドできるはず。
俺はWindowsオンリーなので，誰か手伝ってくれると助かるんだけど．．．

>>408
ほー。そういう着眼点か。

そのdoxygemplateなら、
WindowsビルドしかなくてもLinuxでもWineを使えば普通に動きそうだ。

どげなもんなのか、簡単に解説頼む。

>>409
レスサンクス。

> WindowsビルドしかなくてもLinuxでもWineを使えば普通に動きそうだ。

Linuxのことは知らないのでググってみｔけど面白そう。
タスクトレイもちゃんと使えるの？


>>410
使い方を簡単に言うと、

・起動するとタスクトレイに常駐する。

・エディタで編集中のC/C++のソースの関数宣言（.hでの定義部でも.cや.cppの実装部
　でもOK）をクリップボードにコピーする。宣言の頭から、引数リストの閉じカッコまでが
　入ってればOK。それ以降は入っていても構わないが無視される。

・タスクトレイのアイコンを右クリックして「テンプレート編集」を選ぶと、編集画面が
　現れる。この段階で既に関数の引数やリターン値を解析して、retval コマンド
　とリターン値の型や、param コマンドと引数名が作成されている。
　この画面で param コマンドの[in]⇔[out]⇔[in,out]を切り替えたり、
　行の削除／追加や、details など幾つかのコマンドの追加が出来る。

・編集が終わったら「クリップボード保存」を押すと編集した内容が
　クリップボードにコピーされ、編集画面が閉じる。

・テキストエディタで関数宣言の上にクリップボードから作成されたテンプレートを
　ペーストする。

こんな感じ。

>>411
なるほど、面白そうじゃん。エディタのマクロと巧く連携できればそこそこシームレスに編集できそうだ。

>>411
> タスクトレイもちゃんと使えるの？
俺もそんなにデスクトップLinuxを使い込んでいる訳じゃ無いので、
ごめん、わかんないわ。

タスクトレイに相当するとこも使えそうな気がするけど、
もしダメでもまあLinuxユーザーならソースだけおいとけば
自分でビルドする人が多いだろうしいいんでね？

C言語、UTF-8、日本語コメントあり
を
doxygen 1.6.3
W32TeX (texinst2010.zip)
でpdf出力のためにLaTeXで出力させてみたんですが

epsの出力で

Generating caller graph for function XXXXXXXX
epstopdf ($Id: epstopdf.pl 17507 2010-03-19 22:52:56Z karl $) 2.15
!!! Error: Writing to gs failed, signal 127

ってなります回避する方法はあるのでしょうか？

>>397のバグですが、
Doxygen 1.6.3 で直っていないようでしたので報告しました。

Bug 612858 ? Doxygen takes a NON-INLINE template function for INLINE one mistakenly.
ttps://bugzilla.gnome.org/show_bug.cgi

直してくれるそうです。
やったー！！

死亡回避sage

Doxygen 1.7.0 age

Doxygen 1.7.1 age

>>408
面白いですね。
個人的にはタスクトレイに常駐するより、
Alt + tab で切り替えられる方が使いやすい気がしますが、
どうなんでしょう？
Linuxでどうするの？って問題も無くなると思いますし。

ちなみにemacsユーザーの人は
doxymacs使ってるよね？

>>418
昨日1.7.0インストールしたばかり(ToT)

>>419
レスありがとうございます。

> 個人的にはタスクトレイに常駐するより、
> Alt + tab で切り替えられる方が使いやすい気がしますが、
> どうなんでしょう？

なるほど，それはいいかも知れません。
Linuxは使わないので知らないんですが，Linuxでもアプリケーションの切り替え
はAlt + tabなんですか？ 別にそうでなくても問題はないんですが。

実は最初はWIN32 APIを使って指定キー（Ctrl または Shift または Alt）の指定
回数連打でアクティブになるようにしてたんですが，これだとWindows専用に
なってしまうのでやめたんです。でもやはりキーボードで操作できた方が
いいですよね。

他の操作もキーボードでできるようにするなど，まだ改良点がありますし，
Alt + tabでアクティブになったときにクリップボードから関数の宣言部分を
取り出して処理するとなると，全体の構成も考え直さなければならないので，
少し時間が必要だと思いますが，やってみたいと思います。

ありがとうございました。

>>421
「こんなの」がどんなのか判らないから試してみる気にもなれないのだが。
せめて、どんなのか書いてくれ。

>>422
>>411に書いたんですが。あと>>408のリンク先のスクリーンショットを見て
いただくと雰囲気がわかるかも知れません。

だからさぁ、なんでだらだら説明することしかできないの?

あんたこそダラダラ聞いてないで、とっとと使ってみりゃいーじゃん。
売り物じゃないんだから、>>423だってそうまで言われて使って欲しいとは思わんだろ。

>>424
機能の全容をまあまあ簡潔に説明されてるのに、それすら読まずにわざわざ文句書くのは引くわ。

頭おかしいやつに関わるなよ。

一番エラーとかなく安定してるのって1.5.5？

>>428
もっと新しいのでもいいんでない? 私のところでは1.5.8で止まっているけど。

俺は毎回新しいのにしてるよ。
これから先 更新されていくにあたり、
あんまり最新から離れていると
一気に対応しなきゃならなくなっちゃってめんどくさいから。

genのHPでバージョン使用アンケートとか実施するべきだよな
バージョンあげても劣化することが多いなら、良いベースから作った方がいい
イタチごっこになりかねん

いつの間にかスタイルシートが新しくなってるじゃないか

pythonのソースってFilesに表れる？　RHEL5に乗ってる
1.4.7を使ってるんだけど現れない。　クラスは現れるんだけど。

最新を野良ビルドしようと思ったけど依存関係は深いなあ。

>>433
公式の使用例だと、pythonの場合は@fileじゃなくて@package使ってるみたいだけど。

>>434
ヒントサンクス。　なるほど、そうするとNamespaceの方に現れますね。　
defgroupとかは全然認識してくれないのにそれだけは効きます。

まあ、それでお茶を濁しますか。　

既存のソースをdoxy化しようとしてるんだけど、全てのヘッダーに長いライセンス事項が
書かれてるので、@fileなんかをそのヘッダ上に追加するとファイルの説明にそれが全て
追加されるのが鬱陶しい。　これを隠す方法は何があるでしょう？　とりあえず、

/**
@file hoge.c

doxygen 用のコメント
*/

/*
既存のヘッダーはこっちに隔離
*/

ってしてるんですけど、もっといい方法があるなら知りたいです。

>>436
そのやり方でいいんじゃないか？

まっ、いいか。

しかしdoxygenいいねえ。　今のプロジェクトでドキュメントの無い、コメントの殆どない
ライブラリを使わなくてはならないのだが、ソースを読みながら解析して理解した事はどんどん
コメントに書き加えていき、doxygenを通すと立派なドキュメントが出来上がっていく。　

ライブラリ内の論理構造からいくつかのグループに分け、中心となるファイルのコメントの中で
@defgroupし、関連するファイルは@ingroupでそのグループにまとめる。　@defgroupした
コメントの中ではそのグループの中での主要なコンポーネントを解説。　解説の中で引用する
ファイル名とかクラス名（HogeClass::)、メンバー名等(HogeClass::hogeMemember)の参照は
全て自動的にリンクになるからそのままソースのナビゲーションが出来る。　

最後に@mainpageを作ってこれらのグループ間の関連をメモし、@refでそれぞれのグループに
リンクを張って出来上がり。

ソースを読んで自分なりにメモを作ったり、wikiにまとめたりとかは過去にしたけど、これは
ソースに完全に統合されているので資産として生きながらえると期待する。　

どっかにDoxygenで生成できる旨をコメントしておくことをお勧め。
でないと、Doxygenで生成されたhtmlを編集しようとする馬鹿が出てきかねない。

generated by doxygenってロゴがあるじゃないかー！

graphiz 2.26.3使ってグラフ出力してるんだけど、画像にパスが格納されちゃうんだ
誰かクラス名もしくはファイル名だけ出力出来る方法知らない？

doxyのバージョンによるのかな

#ifdefで囲った部分が無視されるんですが、こういう場合はどうしたらいいんでしょう？

#ifdef HOGE_VER
//! 特定の場合専用の関数
void Hoge();
#endif

DoxyfileでDEFINEできるから、そこでHOGE_VERをDEFINEすれば宜しいかと。

ありがとうございます。PREDEFINEてところに書いたらできました。

PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
とすれば

#ifndef DOXYGEN_SHOULD_SKIP_THIS

Doxygenに無視させたいコード

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

こんなふうに使えます。

1.7.2 キタ

Graphvizの話ってここでしてもいいすかね。
専用スレが見当たらないんだが