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

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

無いので建てた

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

**デフォルトの名無しさん** · 2008/06/07(土) 00:38:33

d + oxygen に見えるからドキシジェンだろ。

**デフォルトの名無しさん** · 2008/06/07(土) 03:42:43

ドキシゲンって読んでたお

HTMLでは、文字化けしないのに
chm作ると、左側の一覧文字化けする
どうしたらいいんだ

**デフォルトの名無しさん** · 2008/06/07(土) 06:03:46

Goo辞書でoxygenの発音
http://dictionary.goo.ne.jp/voice/o/00060383.wav
これにdをつけて読むだろ条項

**デフォルトの名無しさん** · 2008/06/07(土) 14:19:08

doxygenうまいこと使ってる
日本語の人って

Seleneの人以外に居る？
http://selene-lue.halfmoon.jp/

**デフォルトの名無しさん** · 2008/06/07(土) 14:46:47

>>25
「うまいこと」の意味がわからんな。
何か変わった使い方してるの？

**デフォルトの名無しさん** · 2008/06/07(土) 19:16:40

>>25
日本語の使い方が(ry

**デフォルトの名無しさん** · 2008/06/08(日) 01:04:30

チョンでごめんなさい
>うまいこと
俺と比べて、丁寧に利用している意味。
というか、普通に活用してるって意味。

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

>>28
じゃぁ、居るよ、ってことで。

**デフォルトの名無しさん** · 2008/06/08(日) 02:37:06

>>29
氏ね

**デフォルトの名無しさん** · 2008/06/10(火) 22:40:18

まだ30レスにしか達していないのかよ！！

**デフォルトの名無しさん** · 2008/06/11(水) 00:36:37

>>7
今まで単独スレが無かっただけで、話すら無かったわけではないぞ。

良いドキュメント・マニュアル・仕様書を書くスレ
http://pc11.2ch.net/test/read.cgi/tech/1065364445/l50

**デフォルトの名無しさん** · 2008/06/14(土) 14:49:17

Doxygen が吐き出す XML のフォーマットってどっかに仕様書ある?

**デフォルトの名無しさん** · 2008/06/14(土) 18:14:58

XMLなら名前空間のところにURLがあるんじゃないの？

**デフォルトの名無しさん** · 2008/06/15(日) 09:05:34

名前空間のURLのところにスキーマがあるとは限らない

**デフォルトの名無しさん** · 2008/06/15(日) 18:25:33

スキーマって意味まで定義しているんだったっけ。

**デフォルトの名無しさん** · 2008/06/15(日) 18:28:10

隙間って何ですか

**デフォルトの名無しさん** · 2008/06/18(水) 21:45:54

C 言語のソースから HTML 文書を生成するときにモジュールのページに
1つの関数に対して func() と Struct::func() のような2つの名前が表示
されてしまうのですが func() だけにできないでしょうか?

**デフォルトの名無しさん** · 2008/06/19(木) 00:03:43

>>38
OPTIMIZE_OUTPUT_FOR_C はどうしてる？

**デフォルトの名無しさん** · 2008/06/19(木) 12:11:02

もちろん YES です。

**デフォルトの名無しさん** · 2008/06/20(金) 03:07:40

doxygenのlicenseの以下の文章の意味がよく分かりません。

Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

**デフォルトの名無しさん** · 2008/06/20(金) 03:19:30

>>41
doxygen で生成した文書は生成に使われた入力の派生物、つまり、この（ doxygen の）ライセンスに影響されない。

**デフォルトの名無しさん** · 2008/06/20(金) 07:56:23

>>42
どうもありがとうございます。

**デフォルトの名無しさん** · 2008/06/24(火) 14:33:52

C++ のクラスの中の using 宣言は文書化されないのでしょうか?

**デフォルトの名無しさん** · 2008/06/26(木) 11:37:10

インハウスのCライブラリにコメントつけてDoxygenしたら、
100ページ超のrefman.pdfが出来上がってたまげた。

調子に乗ってデベロッパーズマニュアルまでDoxygenで書いてる。
細かいところでアレな事はあるけど、まだ後悔はしていない。
リファレンスマニュアルやサンプル実装と相互参照できていい感じ。
こういうのは、Docbookとかだとめんどくさくて。

**デフォルトの名無しさん** · 2008/07/06(日) 09:53:21

グラフ中のフォントサイズが変更できないんですが、cssを直接弄るしかないんでしょうか

**デフォルトの名無しさん** · 2008/07/11(金) 02:25:54

doxygen使えるな

**デフォルトの名無しさん** · 2008/07/11(金) 20:05:04

VBのコードvbfilter.pyでをdoxygenで出力するとき、一部の宣言の説明が出力されません。
下の例だと、「関数の説明1」が出力されません。
どなたかVBでdoxygenしてる人助言下さい。お願いします。

'*
'*@class cTest
'*@brief テストクラス
'*@author me
'*@version 1.0
'*

'*@fn Function fncTest(obj as Variant)
'*関数の説明1
Public Function fncTest(obj as Variant) As Variant
fncTest = Nullpo
End Function

'*@fn Function fncTest2(obj as Variant)
'*関数の説明2
Public Function fncTest2(obj as Variant) As Variant
fncTest2 = obj.Nullpo
End Function

**デフォルトの名無しさん** · 2008/07/11(金) 21:27:54

>>48
vbfilter.pyの出力を晒してみそ

**デフォルトの名無しさん** · 2008/07/13(日) 02:15:19

>>48
vbfilter.py は、空行を捨ててしまうんですが、
cTest のドキュメントブロックと fncTest のドキュメントブロックがくっついててもいいんでしたっけ?
私も自信ないので…
自分で使う分は空行を通すようにしたりとか、色々と手を加えて使ってます。

なお、 vbfilter.py の説明に、クラスの説明用のコメントは「'*」じゃなくて「'!」で始めるとあります。

それと、doxygen のマニュアルに書いてますが、説明する対象の直前に置くなら、 @fn コマンドはいりませんよ。

50 · 2008/07/13(日) 02:33:51

>>48
もうひとつ思い出した。

vbfilter.py は分割行には対応してないので、
実際の fncTest の1行目の宣言が複数の行に分割されてたら認識してくれません。

**デフォルトの名無しさん** · 2008/07/14(月) 04:02:29

>>50
ありがとうございます！
おかげで正常に出力できました。
ちなみに、関数の前に@fnをつけないとやはり出力されませんでした。
仕方なくつけることにします。

'*@class cTest
'!@brief テストクラス
'!@author me
'!@version 1.0

'*@fn fncTest(obj as Variant)
'*@brief 関数の説明1
Public Function fncTest(obj as Variant) As Variant
fncTest = Nullpo
End Function

'*@fn fncTest2(obj as Variant)
'*@brief 関数の説明2
Public Function fncTest2(obj as Variant) As Variant
fncTest2 = obj.Nullpo
End Function

50 · 2008/07/14(月) 20:30:08

クラス名は、ファイル名やフォーム名から vbfilter.py が勝手に付けるので、
@class コマンドもいりませんよ。

@fn コマンドをつけないと出力されないのは、
1行目の @class コマンドの行頭が「'*」になっているために、
fncTest のドキュメントブロックとくっついてしまって
おかしな事になっているのではないでしょうか。

「'*」で始まる行と「'!」で始まる行は違うタイミングで処理されます。
最初に「'!」で始まる行が検出されて、クラス用のドキュメントブロックが出力され、
対応するc++形式のクラス定義が開始されます。
次にファイルの先頭から1行ずつパターンマッチングされて、
関数の1行目や変数定義や「'*」で始まるコメントがc++の書式に変換されます。
この段階では「'!」で始まる行は飛ばされます。
最後に「}」が出力されて、最初のクラス定義が閉じられます。

なお、関数の中身は全部捨てられてます。
中身の変換の機能追加も一時考えたんですが、挫折しました……。

**デフォルトの名無しさん** · 2008/08/01(金) 22:14:18

ツリー部分の日本語が文字化けしてしまうんですが、どうやったら解決できるでしょう？
今のところ手動で変更してますが、Doxygenの設定でどうにかしたいです。

**デフォルトの名無しさん** · 2008/08/01(金) 23:03:48

doxygenのバージョンと動かしているOS、食わせているファイルのエンコードとDoxyfileの設定などの情報をどうぞ。
私のところでは文字化けしていないので。
# 尤も、日本語のファイル名なんて使ってないからファイル名が化けない保証はないが。

**デフォルトの名無しさん** · 2008/08/02(土) 01:33:38

>>54
バージョン1.5.6 なら、Doxygen自体のバグっぽいです。
公式のバグレポートには、ポーランドの人からも
ポーランド語特有の文字が化けると報告されてます。

1.5.5と1.5.6でツリービューの処理が変わってるので、
そこでエンコーディングの処理をミスしたまま、
作者様はラテン1な国の人なので気付いてないってとこではないかと。

**デフォルトの名無しさん** · 2008/08/02(土) 08:56:42

>>54
1.5.5を使う

55 · 2008/08/02(土) 09:09:18

お、私が使っているのはCygwinのインストーラで入れた1.5.5だ。

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

>>56
thx! (54じゃないけど)

54 · 2008/08/05(火) 21:35:07

ありがとうございます！バージョンの違いってのは気づきませんでした・・・・
これでキー一つでビルド&ビルド後処理ができるようになりました。

**デフォルトの名無しさん** · 2008/08/26(火) 16:11:52

今までdoxygenの事を全く考えずにC++で開発していたんですが、
突然思い立ってdoxygenで出力することにしました。
当然、対応形式のコメントでないので一切出力されません。
一から書き直そうと思うんですが、せめてソースを静的に解析して
関数やファイルの頭に定型のテンプレートを追記してくれるようなツールがあればと
探してるんですが、何かないですかね？

**デフォルトの名無しさん** · 2008/08/26(火) 16:27:23

>>61
そんなことしなくても、コメントの付いてない関数も含めて無理矢理出力させるオプションがあったはず。
DoxyfileのEXTRACT_ALLの項目をNOからYESに変えてみたら？

61 · 2008/08/26(火) 18:34:24

はい。その設定で関数は出るんですが、クラスとメンバが
何をしているかの簡単な説明も表示したいと思っています。
既に大量のソースが存在する為、少しでも手間をかけずに実現したいと試行錯誤中です。
自分の様にプロジェクトの途中からdoxygenの使用を考える人間が、
どのようにこの問題を解決しているのか知りたいところです。

**デフォルトの名無しさん** · 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にしたのを機に捨ててしまったような感じだな。
この正月休みの間に暇があるようならソースでも見てみるか。