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

**デフォルトの名無しさん** · 2008/05/30(金) 19:50:27

無いので建てた

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

**デフォルトの名無しさん** · 2008/08/26(火) 18:39:07

努力と根性じゃね？

**デフォルトの名無しさん** · 2008/08/26(火) 19:53:17

>>63
とりあえず、説明文を付けるのは名前だけで中身を判断できないようなクラスやメンバだけに限定しようぜ。

61 · 2008/08/26(火) 23:15:44

>>64 >>65
先ほどgccxmlを使用して自宅の環境で関数の位置と引数の情報を取得することができました。
ここからコメントを挿入していけばよさそうです。
お二人はdoxygen以外に勉強しなきゃいけないことがあるように思いますよ。
本当にありがとうございました。

65 · 2008/08/26(火) 23:33:51

>>66
四行目が蛇足すぐるwww
でもまあ、健闘を祈る。
あと、無理するなよ。形だけのドキュメント作業なら特に。

61 · 2008/08/26(火) 23:56:08

>>67
大丈夫ですよ、あなたみたいにひ弱じゃありませんから。

61 · 2008/08/27(水) 00:18:56

名無しに戻ろうと思ったのですが偽者が湧いたので。
>>66は私本人ですが、>>68はどこぞの馬の骨です。

>>67
ありがとうございます。
"努力と根性"という言葉に何故かカチンときてしまい棘のある文章になってしまいました。
プログラマやその上司が気軽に使っていい言葉ではないと考えます。
たかが2chの戯言なのに、と自分でも驚いていますが。
ドキュメントはネット上で一般公開予定なので、なるべく解りやすいものを心がけます。

これ以降、私が>>61で書き込むことはありません。
書き込みがあったとしたら、それは私以外の誰かです。

61 · 2008/08/27(水) 00:21:13

いいえ、>69こそがどこぞの馬の骨です。
そもそも、まともな神経をしていたらレスをつけてくれた人に馬の骨なんて使うわけないじゃないですか。

65 · 2008/08/27(水) 00:41:27

ワロタw

**デフォルトの名無しさん** · 2008/09/13(土) 10:38:25

>>61もその程度で躓くレベルでしかもきもいときた

**デフォルトの名無しさん** · 2008/09/25(木) 11:13:21

word出力したら途中までしかクラスが出てこないのは何故？

**デフォルトの名無しさん** · 2008/09/25(木) 12:25:23

>>73
htmlでも出ない？
なんか変な記述があるとそれ以降が出ないことがあった。なんだかは忘れた。

**デフォルトの名無しさん** · 2008/09/25(木) 13:04:40

>>74
htmlだと全部出てるだけど、途切れてる部分見直してみる
ありがと

73 · 2008/09/25(木) 13:26:05

>>74
確認してみたけど、特に変な記述は見当たらなかった
でも、たまに出力先のwordでカタカナ部分が文字化けしているとこがあった
OUTPUT_LANGUAGEがJapaneseだと全く表示されず、Japanese-enだと途中まで表示されて
今Englishに変えたら文字化けだらけだけど全部出てきた

INPUTもOUTPUTもcp932でしてるんだけど、どうすりゃ文字化けせずに日本語だせるかな…

73 · 2008/09/26(金) 15:47:20

追加報告です。
doxygenのVer1.54使っていましたが、1.47でword出力すると問題なくできました
ご迷惑おかけしました

**デフォルトの名無しさん** · 2008/09/27(土) 08:34:51

doxyはバージョンあげると劣化することもあるからなあ
最新版のツリー表示の日本語化け直らないかなあ

**デフォルトの名無しさん** · 2008/10/03(金) 00:09:52

1.5.7 age

**デフォルトの名無しさん** · 2008/10/09(木) 12:07:46

v1.5.7.1 age

**デフォルトの名無しさん** · 2008/10/12(日) 12:08:52

>>78
1.5.6でchm形式でインデックスのエンコーディングを選べるようになって文字化けが解消されたから、それで我慢すれ

**デフォルトの名無しさん** · 2008/10/21(火) 20:34:18

C言語の構造体で、gccのattributeがメンバ「関数」扱いされてしまう
これどうにかならないかな？
OPTIMIZE_OUTPUT_FOR_CはYESになってる

struct Foo
{
int Bar __attribute__((aligned(32)));

**デフォルトの名無しさん** · 2008/10/21(火) 22:37:43

>>82
Cにない構文は、INPUT_FILTERにsedかなにかのスクリプトを指定して事前に取り除くしか。

**デフォルトの名無しさん** · 2008/10/22(水) 01:29:05

>>82 http://www.google.co.jp/search?q=doxygen+%5f%5fattribute%5f%5f

82 · 2008/10/22(水) 10:40:25

>83-84
ありがとう、ただそれだとattributeが消えちゃうよね
なんとか残したまま正しく動作させたいんですよ

**デフォルトの名無しさん** · 2008/10/22(水) 12:17:14

1.5.x で enum EnumName に対して @relatesalso StructName を書くと StructName のページに
EnumName が出るようになるのですが、enum のメンバーのリストが表示されなってしまいました。
1.4.x ではできていた記憶があるのですが、1.5.x で正常にする方法はあるでしょうか？

OPTIMIZE_OUTPUT_FOR_C は YES です。

**デフォルトの名無しさん** · 2008/10/22(水) 12:57:19

>>85 情報後出しキター

**デフォルトの名無しさん** · 2008/10/22(水) 13:22:05

>>85
あんたの言う正しい動作って何なの？

**デフォルトの名無しさん** · 2008/10/24(金) 09:34:27

正しく＝attributeを残したまま、メンバ変数はメンバ変数として認識だろjk

**デフォルトの名無しさん** · 2008/10/24(金) 09:39:03

正しくって……
そんな拡張に一一対応しろってのか?
ソースあるんだろうから自分でやれよと思うのだが。

**デフォルトの名無しさん** · 2008/10/24(金) 10:10:38

いちいちソース書き換えとかコスト見合わないでしょ
だからそれ以外でなんとかする方法を探してるんじゃないか？

まあattributeは確かに独自拡張だが、gccだし割とよく使われてるんで対応してても良いと思う

**デフォルトの名無しさん** · 2008/10/24(金) 10:15:31

汎用的に
構文解析時だけ指定キーワードを無視するオプションがあればいい
つか、ないのかな？

**デフォルトの名無しさん** · 2008/10/24(金) 18:10:58

>>91
あなた流に言うと、コストに見合わないので対応しません

**デフォルトの名無しさん** · 2008/10/25(土) 00:44:08

作者かよww

**デフォルトの名無しさん** · 2008/10/25(土) 17:40:51

そもそもC言語にメンバ関数は無いんだからdoxygenのバグとも言えるだろ
想定外の構文には警告なりエラーなり出して欲しいよな

**デフォルトの名無しさん** · 2008/10/26(日) 00:08:33

例えば@paramとかって変えられないの？

**デフォルトの名無しさん** · 2008/11/08(土) 17:25:21

mac osx 10.5.5
doxygen 1.5.7.1

で実行しようとすると、Failed to run doxygen と言われて一切実行できません。
対処法知っている方、教えて下さい。

**デフォルトの名無しさん** · 2008/11/19(水) 23:51:11

クラス関連図って作れますか？
1クラスの構造を図にはできるみたいですが・・・
C++です。

**デフォルトの名無しさん** · 2008/11/20(木) 00:02:36

graphvizがあればできるよ。

**デフォルトの名無しさん** · 2008/12/17(水) 20:18:15

@dateの後ろに付ける日付をsubversionが自動更新してくれるように
$Date$にしたら、出来たhtmlで日付の見出しが２重になってました。
もしかしてバージョン管理システムのキーワードをdoxygenが認識して
適当に見出し付きで整形してくれるんでしょうか。
マニュアルにそれらしい説明を見た覚え無いんですが。

**デフォルトの名無しさん** · 2008/12/21(日) 21:45:55

公式とかで、きちんとした例が*.hしかないと思うのは気のせい？

**デフォルトの名無しさん** · 2008/12/23(火) 01:27:13

ちょっとメモ。
doxygenで出力したRTFがどうも文字化けするので調べてみたら、\\'を\\\'に変換することで解消することが判った。
要は\を表すのにそれ自身をエスケープして\\とする必要があると言うことなのだろうか。もうちょい調べる必要はありそう。

**デフォルトの名無しさん** · 2008/12/27(土) 23:00:37

日本語がうまく通らない原因ってどこにあるの？

**デフォルトの名無しさん** · 2008/12/28(日) 00:28:11

>>100
doxygenは$date$を認識するみたいだね。だから@dateは書かなくていい

**デフォルトの名無しさん** · 2008/12/28(日) 04:51:23

Doxygen 1.5.8 age

**デフォルトの名無しさん** · 2008/12/28(日) 05:06:03

ｱｯﾌﾟﾃﾞｰﾄｺﾈｰから自分で作るか…

**デフォルトの名無しさん** · 2008/12/28(日) 09:17:52

>>101
ヘッダーに書けば十分だからじゃないかな。

でも、詳細をヘッダーに長々と書いてヘッダーが読みにくくなりそうなときは、詳細だけcppに分けて書くことはあるよ。それでもdoxygenはちゃんとまとめてくれる

**101** · 2008/12/28(日) 15:47:03

>>107 thx

十分かとも思えてきた。
概要かけばいいんだもんな。
漏れは最近doxygen向けのコメント付けはじめたからもうちょい使って慣れてみるわ

**デフォルトの名無しさん** · 2008/12/28(日) 19:40:09

>>103
Shift-JISコードの２バイト目に\を割り当てたマイクロソフトに原因がある。

**102** · 2008/12/29(月) 14:53:28

更に追加。他にも、エスケープすべき文字をエスケープしていない箇所を発見。
xyzzyの場合の正規表現置換でこれを行なうとかなり改善する。
(query-replace-regexp "\$\\\\'..\$\$[{}][^
][^t]\$" "\\1\\\\\\2")
# 場当たり的だなぁ……

**102** · 2008/12/29(月) 14:56:31

あー、済まない、補足。

文字列中に出てくる「{」も「}」も、どちらもエスケープしなければならないと言うのが>110の対応。
但し、文字列中かどうかの判断を厳密に行ないたくないので手元のファイルで場当たり的に対応してある。

誰か、ソース拾ってきて対策してくれる奇特な人はいないもんかのぉ。

**デフォルトの名無しさん** · 2008/12/29(月) 16:04:40

>>111
文字列として表示されるべき「{」や「}」がエスケープされてないってこと？

いつもHTMLしか出してなかったんだけど、試しに手元にあるソースでRTF出してみたら、
こちらではリストをネストさせてるところで、上の階層の行末の書式文字の「{」が
普通の文字として扱われたりして、「{」と「}」の対応が崩れてエラーになってるっぽいです。
(いや、ネストされて表示はされてるから、書式文字以外に余分に「{」が付いてる？)

行末が特定の文字(「定」とか「得」とか)の場合になるみたいだけど、
条件がよくわかりません…

**102** · 2008/12/29(月) 16:16:27

>>112
2バイト文字の2バイト目に{}\のいずれかが来るケースで、エスケープされないようです。
# 「定」「得」どちらも該当しないようですが……

処が文字列を明示的に区切らないのがRTFの仕様らしくて、キーワードとしての{や}と区別が難しいのですよ。
実は>102の対策だけだと{}の対応が崩れてしまってrtfの一部だけしか読み込まれないことが判って気づいたんですが。
# 客先に実態の1/3程度しか分量がない資料を提出しちゃったのは内緒w

念のため確認したら、手元のDoxygenはCygwin同梱の1.5.5でした。
# さて、rtfを変換するツールを真面目に作るのとdoxygenそのものを修正するのとどっちが楽だろかw

**デフォルトの名無しさん** · 2008/12/29(月) 16:26:38

>>113
だいぶ前からエンコーディング指定して全部一旦 UTF-8 に変換されるようになったから
その手の問題は解決済みだと思ってるんだけど、何かバージョン上げれない理由でもあるの？

**デフォルトの名無しさん** · 2008/12/29(月) 17:54:50

cygwinの最新は1.5.5-1だね。
つまり、解決済みではないらしい。

**デフォルトの名無しさん** · 2008/12/29(月) 18:19:03

cygwinは使ってないので、それが理由かどうかは知りませんが、
1.5.6から1.5.7.1まではフレーム付きHTMLのツリービューで
英数字以外が文字化けするという問題がありました。
2日前に出たばかりの1.5.8でやっと解決されました。

**デフォルトの名無しさん** · 2008/12/29(月) 19:13:27

>>115
Windows ネイティブ版を使えない理由があるの？

**デフォルトの名無しさん** · 2008/12/29(月) 20:15:40

全部一旦 UTF-8 に変換されるようになったのは、1.5.2以降だから、
>>113, >>115 の cygwin版も UTF-8 に変換されるバージョンです。

最新版でも日本語RTFはかなり駄目な感じです。
手元のソースを処理させてみたら、目次の見出しの「目次」の後ろとか、
あちらこちらに見えてはいけない「\par」や「{」が見えて、
本文数ページで破綻します。

**デフォルトの名無しさん** · 2008/12/29(月) 20:53:32

HTML だと問題ないってことかな？ HTML しか使ってないからよくわかんないや。

**118** · 2008/12/29(月) 22:31:08

昔、1.4.6でRTFを作ったことのあるソースを、設定をほとんど変えずに1.5.8に掛けても駄目でした。
1.4.6で作ったRTFの半分ぐらいしかファイルサイズがありません。
むしろ内部処理が UTF-8 になってから、おかしくなったんじゃないかという気がしてきました。

**デフォルトの名無しさん** · 2008/12/29(月) 23:06:51

折角色々対応してあったのを、UTF-8にしたのを機に捨ててしまったような感じだな。
この正月休みの間に暇があるようならソースでも見てみるか。

**デフォルトの名無しさん** · 2008/12/30(火) 01:23:34

過去のバージョンを取ってきて順に試してみました。
1.5.0までは日本語の RTF が生成できて
(おかしなところが無いかまではチェックしてませんが)、
1.5.1で、
"Warning: Output language Japanese not supported! Using English instead."
と表示され、日本語が表示できませんでした。
ここで一旦無かったことにされたようです。

**デフォルトの名無しさん** · 2008/12/30(火) 03:40:46

問題分かったかも。

id 437346 のバグレポートで日本語対応の議論がされてるんだけど、
報告者の人が提案した、
x080より大きいバイトが来たらマルチバイト判別フラグON、
次のバイトでフラグOFF、というのをそのまま採用してくれたらよかったのに、
0x80より大きいかの判断をそのままフラグに入れちゃってるから、
2バイト目が0x80より大きい場合に、その次のバイトまでエスケープされて、
それがエスケープされたら困るものの場合に不幸になってるということかと。

**デフォルトの名無しさん** · 2008/12/30(火) 03:58:34

repopかければいいのに。

rtfって何で読めるんだろう。AbiWord?ooo?

**デフォルトの名無しさん** · 2008/12/30(火) 08:55:13

>>123
事はそう単純じゃない。というか、もっと単純。
内部UTF-8をcp932に変換して、必要ならエスケープすべきなのにそれをしていないと言うのが>102=113の観測だろ。
例えば「ソソ」が「\'83\\\'83\\」にならないといけないのに「\'83\\'83\」になると。

それとも、二種類の問題が独立して存在しているのか?

**123** · 2008/12/30(火) 10:22:07

>>125
ああ、すいません。
>>123で書いたのは、1.5.8の場合の問題です。
>>102,,>>113の、.1.5.5の問題はエスケープされてないというので合ってると思います。
1.5.8でそれに対する対応が入れられたけど、方法がまずく、
今度は逆にエスケープすべきでないところまでされたという話。

**デフォルトの名無しさん** · 2008/12/30(火) 11:17:38

>>78
1.5.8で直った

**デフォルトの名無しさん** · 2009/01/08(木) 07:49:37

とりあえず保守ですが、あけおめ。

日本語rtf使えるようになるといいですね

自分はまだ皆様のようにハックに参加できるほど技術がないので、精進したいと思います。

**102** · 2009/01/08(木) 09:55:41

又更につまらない問題に遭遇。
折角修正したrtfがWordだと読めるのにOpenOfficeだと文字化けする。
例えば、「\'83\\」のような>125が指摘した例だと、「\'83\'5c」のようにしないといけないらしい。
あーもう、rtfを解析するしかないのかなぁ。
# doxygen1.5.8で変わっているらしいからそっちに手を出すのは避けたいし。

**デフォルトの名無しさん** · 2009/01/08(木) 22:19:22

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

**デフォルトの名無しさん** · 2009/01/10(土) 14:59:07

1.5.8 のrtfのエスケープバグのソースって
どのファイルなのかな？

**102** · 2009/01/10(土) 15:17:25

ちょっとLinuxに1.5.8をインストールしたので出力してみたが、これは酷いw
2バイト文字を全てコード出力しているのはいいが、>123のように無関係なコマンド文字まで巻き添えにしてしまっている。
おまけに、コマンド文字列を何故か\commentで括ってしまっているので収拾がつかない状態。

そうそう、html出力のツリービューも、(UTF-8)指定なのにも関わらずプロジェクト名がEUCで出力されるので化け化け。
誰かなんとかして～w
# ってことで、>131に期待♪

**デフォルトの名無しさん** · 2009/01/11(日) 01:06:49

うはｗ　ぼくとしては>102さんに期待してるんだけどっｗ

**デフォルトの名無しさん** · 2009/01/12(月) 00:56:25

>>131
rtfgen.cpp の void RTFGenerator::postProcess(QByteArray &a) です。
こちらを参考に。
ttp://bugzilla.gnome.org/show_bug.cgi?id=437346

>>132
そういや最近プロジェクト名を日本語にしてなかったけど、これは…

どうやらDoxywizardのバグのようです。
テキストエディタでDoxyfile開いてプロジェクト名を修正して、
コマンドラインでDoxygenを実行したら、文字化けしませんでした。

**デフォルトの名無しさん** · 2009/01/12(月) 02:36:31

>>134 ソース位置ありがとう。
これって、よくわかってないけど、postProcess()で、ファイル全体を
エスケープしてるのかな。
もしそうなら、rtfでの表示される文字列以外も全部エスケープされて
しまい、上のバグが症状がでてるんじゃないかな？
rtf表示文字列だけをエスケープするようにするには、postProcess()
の中でやってちゃだめで、rtfgen.cpp（にあるか知らないけど）
で表示文字列をrtfタグ中に埋め込む時コード当たりでやらないといけなそう？

とりあえず、doxygenをWindowsでコンパイル出来る環境作り
からやらないといけないのが辛いorz

**デフォルトの名無しさん** · 2009/01/12(月) 08:13:44

>>135
頑張れw
Cygwinなら協力する。
# つーか、ソース拾ってきて自分でやれ＞自分

**134** · 2009/01/12(月) 21:40:12

>>135
0x80より大きい値とmb_flagが1のときだけエスケープされるはずです。
1.5.7.1以前のバージョンではmb_flagが無くて、0x80より大きい値という条件しかなかったので、
マルチバイト文字の2バイト目が「{」や「\」などの場合におかしくなってました。

mb_flagをマルチバイト文字の1バイト目で1にすれば、
次のバイトが0x80以下でもエスケープされるという仕組みのはずですが、
mb_flagの設定方法がまずくて、２バイト目でクリアされなくて
さらに次のバイトまでエスケープされる場合がある、という状況です。

ttp://bugzilla.gnome.org/show_bug.cgi?id=437346
で、T.Matsuyama氏が提示したコードが正しく動くはずです。

＃そこまで分かってるな自分でやれ、と言われそうだ……
すいません、環境作りが荷が重いですorz

**デフォルトの名無しさん** · 2009/01/14(水) 22:11:56

バグ修正版バイナリ出来たよん。
http://www1.axfc.net/uploader/He/so/182473&key=doxygen
T.Matsuyama氏パッチそのままです。
ばっちりっぽいです。
102さん、134さんありがとｗ

**デフォルトの名無しさん** · 2009/01/14(水) 22:17:06

おー、これは凄い。後で試してみるか。

**デフォルトの名無しさん** · 2009/01/27(火) 01:28:30

てか、>>137のURLが示すバグをreopenして開発者に教えてあげればいいんじゃないの？
アカウント持ってないから誰でもreopenできる設定なのかはわからないけど

**デフォルトの名無しさん** · 2009/01/27(火) 07:49:20

いかん、未だ試せてない……

**デフォルトの名無しさん** · 2009/01/30(金) 01:55:55

コメントが一切ついてないソースに
関数の定義部分だけ自動的に
タグを生成してくれるツールないですか？

**デフォルトの名無しさん** · 2009/01/30(金) 02:14:58

>>142 ctags?

**デフォルトの名無しさん** · 2009/01/30(金) 07:39:05

>>142
このスレ的には、タグというとDoxyfileのタグのことになるのだがそれでいいのかい?

**デフォルトの名無しさん** · 2009/01/30(金) 07:42:20

@が付くやつがいい

**デフォルトの名無しさん** · 2009/01/30(金) 08:23:53

ドキュメントつけしてない関数も出力するオプション？

**139** · 2009/02/15(日) 17:55:27

やっと>138を試せた。取り敢えず、cygwinからでも使えることと日本語が化けないことは確認した。
但し、OpenOffice(3.0)では{comment[^{}]}を取り除く必要があったこととTITLEなどのフィールドは
巧く変換できなかったけれど、これは元からそうなのかもしれない。
今度機会があれば、素直にMSwordに食わせてみるとしよう。

**139** · 2009/02/17(火) 18:58:43

cygwinで>138を動かし、できたRTFをWORD2000に食わせた。
全選択してフィールドの更新、画像アンリンクのマクロを動かして、
docに名前を変えて保存。一応、スタンダロンで使える資料になるようだ。

で、画像アンリンクのマクロって需要あるかな。あるようならどっかで公開するけど。

**デフォルトの名無しさん** · 2009/02/28(土) 05:29:11

doxygenのライセンスってGPLですよね。
doxygenのコメントを書いたソースって公開しないと駄目ですか？

**デフォルトの名無しさん** · 2009/02/28(土) 05:39:00

ならないよ
GPLのお絵かきソフトで絵を描いたようなもん

**149** · 2009/02/28(土) 05:50:38

>>150
ありがとうございます

**デフォルトの名無しさん** · 2009/03/03(火) 10:33:16

DoxyfileもGPLに該当しないのかな。
それとも、コメント部分は削除しておいた方が無難?

**デフォルトの名無しさん** · 2009/03/03(火) 22:08:28

ソフトのドキュメントを作るのにDoxygenを利用してもGPLにする必要なし。
ソフトの機能としてDoxygenを利用する場合はGPL。

**デフォルトの名無しさん** · 2009/04/06(月) 21:16:11

@a と @p ってどう使い分けてる？
どっちも文中の引数のフォントを変えるために使うものみたいだけど。

**デフォルトの名無しさん** · 2009/04/08(水) 12:32:53

\aは「特殊なフォント」ということで一般的にはItalicかな。
\pは\cと等価で「タイプライタフォント」ということで等幅フォントが使われる。
後は、実際の出力を見て検討したら?

**154** · 2009/04/09(木) 00:04:14

普通はどうする、ということは特になくて、見た目の好みで使えばいいのですか。
ヘルプを見ると、@aは "refer to member arguments" 、
@pは "refer to member function parameters" と書かれてて、
微妙に使い分けがあるようなないような、よく分からなかったもので。

**デフォルトの名無しさん** · 2009/04/09(木) 07:14:32

意味で使い分ければいいと思う。
フォントとかの体裁はCSSで変えられるんじゃなかったかな？やったこと無いけど。

**デフォルトの名無しさん** · 2009/04/09(木) 08:11:53

@a の argument が実引数で @p の parameter が仮引数なわけだけど、
コメント中では仮引数しか現れない気がする。実引数が現れることなんてあるか？

**デフォルトの名無しさん** · 2009/04/09(木) 09:06:56

恣意的に使い分ければいいんじゃね?

>>157
出力するものによって指定するスタイルシートや指定方法は違うけど、htmlならcss,だね。
やったことないけどw

**デフォルトの名無しさん** · 2009/04/10(金) 04:10:58

member argumentがクラスのメンバー変数ってことはないかな。

**デフォルトの名無しさん** · 2009/04/10(金) 23:50:56

>>158
@p param1 の値が @a xxx だったら～
みたいな説明を書くのに使うとか?

**デフォルトの名無しさん** · 2009/04/25(土) 21:37:10

メソッドのコメントは、戻り値がなくても「@return なし」と明示的に書くべきでしょうか？
引数がない場合も同様に「@param なし」と書くでしょうか？

**デフォルトの名無しさん** · 2009/04/25(土) 21:38:20

前者はお好きにどうぞ。
後者は「なし」なんて引き数はないぞって警告が出るんじゃないかな?