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

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

無いので建てた

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

**デフォルトの名無しさん** · 2010/09/26(日) 23:29:16

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

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

**デフォルトの名無しさん** · 2010/09/27(月) 00:57:34

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

**442** · 2010/09/27(月) 03:24:37

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

**デフォルトの名無しさん** · 2010/10/09(土) 22:35:39

PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
とすれば

#ifndef DOXYGEN_SHOULD_SKIP_THIS

Doxygenに無視させたいコード

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

こんなふうに使えます。

**デフォルトの名無しさん** · 2010/10/12(火) 03:11:52

1.7.2 キタ

**デフォルトの名無しさん** · 2010/10/30(土) 16:40:01

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

**デフォルトの名無しさん** · 2010/10/30(土) 20:12:25

Doxygenで使う限りにおいてはＯＫじゃね？

**デフォルトの名無しさん** · 2010/11/01(月) 12:16:48

>>447
doxygenに絡まないならこの辺で。
スレ立てるまでもない質問はここで 108匹目
http://hibari.2ch.net/test/read.cgi/tech/1287477677/

私も興味あるから是非。

**デフォルトの名無しさん** · 2010/11/01(月) 14:11:14

まったく絡まないので、あとでスレ立てするわ
昔はGraphvixのスレあったみたいだし、続きってことにする

**デフォルトの名無しさん** · 2010/11/04(木) 00:23:09

Graphvixについて答えられる有識者はいるんだろうか。

**デフォルトの名無しさん** · 2010/11/04(木) 10:19:10

うむ。寡聞にしてGraphvixなるものは与り知らないな。

**デフォルトの名無しさん** · 2010/11/04(木) 10:54:48

vixじゃなくてvizだよ！わざとだよ！ついだよ！

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

Graphvizって言えば、同じrankにあるnodeの位置関係のヒントって与えられないかな。
doxygenからの出力でも、関数ツリーの上下がある程度同じになってくれると助かるんだけど。
例えば、
main->a->b
　　　 ->c-^
が
　　　 ->c-v
main->a->b
になったりしないように。

**デフォルトの名無しさん** · 2010/11/05(金) 19:08:08

>>454
Graphviz(というかdotエンジン)単体なら、group属性を指定しておけばある程度は制御できる。
doxygenからは(事実上)無理。関数ツリーの上下が変わるのって下請け関数の影響が大きいから
レベルを指定して下請けまで展開しないようにするってのも手。まぁ、どうしてもってことなら自作するしかw

**デフォルトの名無しさん** · 2010/11/19(金) 12:12:25

派生クラスで仮想関数を再定義した場合、派生クラスのメンバー一覧にこの関数が表示されますが、
これを非表示にするにはどうすればいいでしょうか?
数が多く基底クラスで表示してくれれば充分です。

**デフォルトの名無しさん** · 2010/11/19(金) 12:26:29

・仮想関数がprivateならDoxyfileでprivateなメンバ関数は出力しない設定にする
・#ifndefで括って、Doxyfileでそのマクロを定義する
・他の出力したい関数にDoxygenコメントが必ずあるなら、Doxygenコメントのない関数は出力しない設定にする

**デフォルトの名無しさん** · 2010/11/19(金) 13:44:48

3番目の方法で出来ました。ありがとうございました。
HIDE_UNDOC_MEMBERS = YES
ドキュメントづけは全部やるのでこれで大丈夫です。

**デフォルトの名無しさん** · 2010/11/26(金) 20:32:20

doxygenで内部用と外部用のドキュメントの2種類を作りたいのですがどうのうな形にするのが
いいですか。
とりあえず全部ドキュメントを書いておいて外部用の場合は
非公式なクラス、関数を隠したいのですが、どうすればいいのやら。

**デフォルトの名無しさん** · 2010/11/26(金) 20:40:49

>>459
>>340の応用で
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
とかにすれば。
これを内部用と外部用のマクロにすればおｋ！

**デフォルトの名無しさん** · 2010/11/27(土) 12:15:32

いや、まず @internal の使用を検討する方が先だろう。

**459** · 2010/11/27(土) 12:19:20

>>461
@internal でいけました。
探していたのはこれです。有難うございました。

**デフォルトの名無しさん** · 2010/12/16(木) 18:07:20

hosh

**デフォルトの名無しさん** · 2011/01/04(火) 13:01:20

明けましておめでとうございます。
hosho

**デフォルトの名無しさん** · 2011/01/05(水) 08:16:00

1.7.3 が出ました

**デフォルトの名無しさん** · 2011/01/08(土) 11:21:38

バグが2つ取れて新たに1つ入るんだよなこれって。

**デフォルトの名無しさん** · 2011/01/15(土) 20:33:03

C++で多重継承していた場合、一番最後に指定したクラスのオーバーライド関数しか「～を実装しています。」が出ないな。
例えば、

class BasicActor : public Actor, public IEventListener
{

だとActorの方の仮想関数をオーバーライドしても「～を実装しています」が表示されない。
ActorとIEventListenerの順番を入れ替えると逆の方のクラスの関数の「～を実装しています」が表示されない。
早く治るといいなあ。

**デフォルトの名無しさん** · 2011/01/20(木) 21:42:56

doxygen凄く便利そうだな！だけどRTF出力がうまくいかね…。
一応>>138のバイナリとdoxywizard(1.7.3)で試してるんだが、

OUTPUT_LANGUAGE=Japanese
INPUT_ENCODING=CP932

以外に何か設定って必要なのか？
もし良かったらだれかDoxyfileをうｐしてくれると凄く助かるわ…。

**デフォルトの名無しさん** · 2011/01/21(金) 00:23:16

>>468
OUTPUT_LANGUAGE=Japanese-en

**デフォルトの名無しさん** · 2011/01/21(金) 21:50:09

>>469
レスサンクス！
拾ってきたサンプルソースがCP932じゃなかったというどうしようもない原因でしたorz
スレ汚しスマソ

**デフォルトの名無しさん** · 2011/04/05(火) 10:52:41.34

1.7.4 が出たようですが....
試してみた人います？

**デフォルトの名無しさん** · 2011/05/14(土) 11:06:54.20

1.7.4の日本語のｒｔｆ出力やっぱりおかしい。
以下、対処メモ。
>102,>134を参考にソース修正・コンパイルして日本語ｒｔｆ出力できたの確認。
doxygen-1.7.4/src/rtfgen.cppのencodeForOutputを修正
uint i;
uint mbFlag=0; // ←追加
for (i=0;i<enc.size();i++)
{
uchar c = (uchar)enc.at(i);
if (c>=0x80 || mbFlag==1) // ←修正
{
char esc[10];
sprintf(esc,"\\'%X",c);
mbFlag=1-mbFlag; // ←追加
t << esc;
}
else
{
t << (char)c;
}
}

**デフォルトの名無しさん** · 2011/06/09(木) 18:58:40.57

@だとドキュメント付けできて、\だとできないのは何故ですか？

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

>>473
言ってることがよく判らん。普通に@paramでも\paramでもできると思うが。

**デフォルトの名無しさん** · 2011/06/10(金) 09:31:34.72

>>474
ところが、\paramだとだめで、@paramだとできるんすよ。
何か切り替えるようなオプションがあるのだろうか？

忍法帖【Lv=3,xxxP】 · 2011/06/10(金) 14:41:51.21

そのダメなファイルと環境とリビジョンについて詳しく。

**デフォルトの名無しさん** · 2011/06/16(木) 12:06:46.19

\\にすればおｋ

忍法帖【Lv=6,xxxP】 · 2011/06/16(木) 21:55:08.60

んな馬鹿な

**デフォルトの名無しさん** · 2011/06/17(金) 15:09:51.06

馬鹿っていうほうが馬鹿

**デフォルトの名無しさん** · 2011/08/26(金) 14:21:37.30

復帰

**デフォルトの名無しさん** · 2011/09/15(木) 21:14:39.34

#define HOGE 123
msg.h の 20 行で定義されています
みたいな行番号表示をオフにするにはどうしたらいいの？

**デフォルトの名無しさん** · 2011/10/27(木) 08:42:23.16

1.7.5.1 は日本語 rtf 出力の文字化けが直ったみたいだ。

**デフォルトの名無しさん** · 2012/02/16(木) 01:44:46.69

C++で、ソースを弄りたくない他所のライブラリの基底クラスのpublicなメソッドのリファレンスを
自作の派生クラス側のソースで書く事ってできないもんでしょうか。

**デフォルトの名無しさん** · 2012/02/17(金) 00:52:56.77

>>483
宣言や定義の直前にしかその関数etcの説明を書けないと思っているなら一度doxygenの使い方をちゃんと勉強すると良い。
doxygenのタグのリファレンスを眺めるだけでも全然違うと思う。

**483** · 2012/02/21(火) 23:05:35.96

@fn を書いているのに出力されないと思ったら、うっかり他のネームスペース内に書いていた為でした。
お騒がせしました。

**デフォルトの名無しさん** · 2012/02/26(日) 01:02:49.50

Doxygen 1.8.0 age

**デフォルトの名無しさん** · 2012/02/26(日) 01:16:48.60

x64バイナリも出たんだな

**デフォルトの名無しさん** · 2012/03/01(木) 14:57:23.15

こういう、箇条書きをインデントさせると
　　/*!
　　　　　　- 列挙したい場合はこのように先頭に -をつける
　　　　　　　　- 更にインデントをつけたいときはこうする
　　　　　　　　　　- 更にインデントをつけたいときはこうする
　　*/

　・列挙したい場合はこのように先頭に -をつける
　　　・更にインデントをつけたいときはこうする
　　　　　・更にインデントをつけたいときはこうする

こうやってくれるんだけど

これを、このように、
ソースにそった形でインデントさせたいんだけど

　　//! - 列挙したい場合はこのように先頭に -をつける
　　if (a == 1) {
　　　　//! 　　- 更にインデントをつけたいときはこうする
　　}

これを普通にやると
　・列挙したい場合はこのように先頭に -をつける
　・更にインデントをつけたいときはこうする
こうなっちゃうんだよね

「単独行で、強制的に２つ以上のインデント」させる、いい方法ないかねぇ

というか、そもそも
doxygenは、こういうコメントを書くべきじゃないのかな？

**デフォルトの名無しさん** · 2012/03/05(月) 04:23:13.19

やはりテンプレート関連でおかしくなるなあ

**デフォルトの名無しさん** · 2012/05/21(月) 11:48:57.46

Doxygen 1.8.1 age

**デフォルトの名無しさん** · 2012/06/13(水) 13:00:33.35

http://www.doxygen.jp/manual.html にあるマニュアル、
一括ダウンロードできるようになってないのかな。
Webに繋がっていないときにこそ見たいときが多くて、歯噛みすることが多いんだけど。
# 取り敢えず、コマンドのページだけはダウンロードしておいたけど実例見られない……

**デフォルトの名無しさん** · 2012/06/14(木) 15:19:16.46

「階層まるごとダウンロードツール」使えばええんちゃうのん

**デフォルトの名無しさん** · 2012/07/17(火) 13:19:18.40

C#で表示されるクラス名が全部
＜パッケージ名＞.＜クラス名＞
になってすごく見づらいんですが、これをクラス名だけにする方法を教えてください
何というオプションなのかそもそも名前がわかりません

**デフォルトの名無しさん** · 2012/07/17(火) 13:26:33.37

HIDE_SCOPE_NAMESでいけた。お騒がせしました

**デフォルトの名無しさん** · 2012/07/24(火) 20:50:05.56

クラスの階層じゃなくて、依存関係をグラヒカルに見たいんだけど
なにを設定すればいいんだっけか

**デフォルトの名無しさん** · 2012/07/25(水) 11:08:33.44

HAVE_DOT
後は適当に。

**デフォルトの名無しさん** · 2012/10/14(日) 16:05:32.12

気になるけどまだ使っていない。
便利なんだろうか？

**デフォルトの名無しさん** · 2012/10/14(日) 18:43:04.08

使えば判る。是非使え。

**デフォルトの名無しさん** · 2012/11/17(土) 02:10:59.92

Doxygen 1.8.2 age

**デフォルトの名無しさん** · 2012/12/01(土) 05:59:46.03

doxygenで制作されたライブラリのレファレンスがあるんだけど、オフラインで見たいからダウンロードしたいんだが、なにか方法はないだろうか。
なんかサーバー側の調子が悪いのか、見たい時に中々見れない時とかあって困ってるんだ。

なんかメインページがphpだからなのか、普通のダウンロードツールじゃうまくいかないんだ。

**デフォルトの名無しさん** · 2012/12/01(土) 06:02:58.31

じっさいに見てみないことには何とも言えん
URIはよ

**デフォルトの名無しさん** · 2012/12/01(土) 07:16:56.55

doxygenで出力されるのは通常htmlで、phpじゃないよ。
そうでなくても、このスレで聞くのはスレ…いや、鼬害。

**デフォルトの名無しさん** · 2012/12/01(土) 19:32:43.73

\relatesは関数にしか機能しないということですが、同じようにC++のクラスを他のクラスに関連付ける手段はないでしょうか？

//何かのTraitsクラステンプレート
template < typename T > xxxx_traits;

/*! クラスA
*/
class A { ... };

/*! xxxx_traitsのクラスAに対する特殊化バージョン
　\relates A　← 例えばこんな風に
*/
template <>
struct xxxx_traits< A > {.... };

クラスAのドキュメントからxxxx_traits< A >へのリンクを張りたいのですが。

**503** · 2012/12/01(土) 19:51:28.94

書き忘れていました。
今は、クラスAのドキュメントから\saでリンクを張っています。
しかし、Related Functionsと同列にできないものか、と思ったのです。
後出しですいません。

**デフォルトの名無しさん** · 2012/12/02(日) 00:27:49.22

プログラム関係で詳しい奴っている？

**500** · 2012/12/05(水) 18:40:16.24

>>501 >>502
doxygenで構築されるのはhtmlなのか。
ソースコード向けホームページ作成ツールみたな認識でいいんかな。
ってことはdoxygenを仮にインストールしたとして、WEB上にあるdoxygenで出力したページはhtmlとかだからgitみたいにダウンロードするとかそういうのも無いんか

ちなみにURLはこれ
ttp://www.arongranberg.com/astar/docs/

**デフォルトの名無しさん** · 2012/12/07(金) 01:22:50.83

>>506
使った事はないけどpdfへの出力もサポートしてるよ。

Output Formats
http://www.stack.nl/~dimitri/doxygen/output.html

**デフォルトの名無しさん** · 2012/12/07(金) 11:28:30.72

TeXからps経由でpdfにするのは日本語の扱いで結局満足いく出力になったことがないんだよなぁ。
rtfからdoc経由でpdfにするのはMS-Office2010があれば日本語も大丈夫なようだけど。

**デフォルトの名無しさん** · 2012/12/11(火) 13:15:43.39

>>506
wget --mirrorとか。

**デフォルトの名無しさん** · 2012/12/27(木) 01:20:09.22

Doxygen 1.8.3 age

**デフォルトの名無しさん** · 2012/12/27(木) 13:15:24.02

New features 見てみた。External Indexing and Searching 面白そうだな。
ttp://www.stack.nl/~dimitri/doxygen/extsearch.html

**デフォルトの名無しさん** · 2013/01/17(木) 19:51:25.05

RTFで出力したときに
1.先頭ページが「TITLE AUTHOR Version 1.0.0 CREATEDATE」となり内容が出力されない。
2.３ページ目が「目次 Tavle of contents」となり出力されない
3.最終ページが「索引 INDEX」となり出力されない
4.デストラクタ「~」で始まる名称が文字化けする
version は1.8.2 です。
DOXYFILE_ENCODING = UTF-8
INPUT_ENCODING = SJIS
としています。個別でも構いません解決方法ご存知の方はおられませんか。

**デフォルトの名無しさん** · 2013/01/18(金) 09:11:06.86

>>512
INPUT_ENCODING=CP932
の方がいいと思います。
後は、MS WORD で読み込んで全文選択した後フィールド更新

**デフォルトの名無しさん** · 2013/01/18(金) 09:23:11.01

>>513
早速やってみたら全てきれいに解決しました。
ありがとうございました。

**デフォルトの名無しさん** · 2013/01/18(金) 18:25:25.37

＞2.３ページ目が「目次 Tavle of contents」となり出力されない
なんだこれ。

**デフォルトの名無しさん** · 2013/01/18(金) 18:28:31.06

>>515
「目次 Table of contents」のパンチミスでした。m(__)m

**デフォルトの名無しさん** · 2013/01/22(火) 23:35:14.46

Doxygen 1.8.3.1 age

**デフォルトの名無しさん** · 2013/04/05(金) 22:53:14.91

Doxygen 1.8.3.1 使ってます
rtfの出力なのですが

VisualStudio 2010でC#で使おうと思ってます

DOXYFILE_ENCODING = CP932
INPUT_ENCODING = UTF-8

として、出力したところ
refman.rtf
は何となくそれっぽい出力をされているのですが
おまけで作られる大量のrtfファイルが、UTF-8のままなのか文字化けしちゃいます

refman.rtfファイルに対して、ワード２００７で
読み込んで全文選択した後フィールド更新
としても、おまけファイルが取り込まれた様子もないです(おまけファイルの図が取り込まれていない)

それと、目次が「TOCが間違っています」・・・
というエラーになってしまうページがあったりします

doxygenはあまりワード出力は向いてないのでしょうか
htmlは結構イメージしたものに近い出力だったのですが

**デフォルトの名無しさん** · 2013/04/10(水) 15:03:15.14

>>518
ソースもcp932にしないと難しいかもね。
それと、word2010にしたら改善するかもしれない。
いずれにしても、日本語は相性悪いよ。
そうそう、JapaneseでダメならJapanese-enも試してみる価値あり。

**デフォルトの名無しさん** · 2013/05/06(月) 14:48:10.14

1.8.3.1で、C言語でグローバル変数を使う時に、
(foo.h)
extern int a;
(foo.c)
int a;
って書くと出力にaが2個現れるのですが、仕様でしょうか

**デフォルトの名無しさん** · 2013/05/06(月) 14:53:50.36

@addtogroupでcとhを同じグループに入れた時だけ>>520みたいな状態なので、とりあえずexternの部分だけグループから外します

**デフォルトの名無しさん** · 2013/05/06(月) 15:13:09.82

externはグループから外さなきゃいけないか
まあそりゃそうだな
失礼しました

**デフォルトの名無しさん** · 2013/05/10(金) 23:59:33.52

doxygenを意識していないソースコードに
doxygen用のコメントのテンプレートみたいなのを書き込む機能ってありませんか？
例えば

class Hoge
{
...
};
などとあったら
/**
* @brief brief of Hoge
*
* detail of Hoge
*/
class Hoge
{
...
}:
のようなコメントを挿入するような

**デフォルトの名無しさん** · 2013/05/12(日) 07:16:01.98

>>523
つeclipse

**デフォルトの名無しさん** · 2013/05/13(月) 17:14:58.88

>>523
んなもん、Doxygenにあるわけないだろ。
LL言語で作るかエディタのマクロで作るかすればいいだろうが、それはスレ違い。
あぁ、JavaDocスタイルを有効にしておけば、もそっと簡単になるな。

**デフォルトの名無しさん** · 2013/05/13(月) 20:40:48.28

でもそれこそdoygenにパーサがあるわけだから、doxygen内蔵でそういう機能があったらいいなとお思うのは
自然で低コストだべ？

**デフォルトの名無しさん** · 2013/05/14(火) 01:41:00.13

VisualStudio で C++ なら DoxyComment だろうけど。

**デフォルトの名無しさん** · 2013/05/14(火) 05:45:06.00

ありがたい、求めていたものはそれです

**デフォルトの名無しさん** · 2013/05/14(火) 12:51:38.41

>>527
これ便利そうやな
コマンドライン版ある？

**デフォルトの名無しさん** · 2013/05/14(火) 20:11:22.93

>Express Editionでは使えません
チクショー！

**デフォルトの名無しさん** · 2013/10/28(月) 16:59:29.04

細かいのはヘッダファイルに書く派？ソース本体に書く派？

**デフォルトの名無しさん** · 2013/10/28(月) 18:54:07.23

本体と別々にdoxygenコメントを書くことはねーよ。doxygenのいいところが全く無駄になるだろ。
ヘッダファイルに書くのは前方宣言とマクロ定義くらいだから当然ソース本体にしかdoxygenコメントなんざ書かない。

**デフォルトの名無しさん** · 2013/10/31(木) 15:00:35.36

@parのなかでPREタグ使いたいんだけどうまくいかない
AAとか書くときってみんなどうしてるの？

**デフォルトの名無しさん** · 2013/10/31(木) 15:27:12.80

AAとか書かない

**デフォルトの名無しさん** · 2013/10/31(木) 20:46:05.36

>>534
きみの思いとか気持ちを聞いているわけじゃあないんだ。わかるね？

**デフォルトの名無しさん** · 2013/11/01(金) 16:50:18.73

>>535
なんのAA書きたいんだよ

**デフォルトの名無しさん** · 2013/11/01(金) 17:41:02.50

>>536
┌─┬─┬─┬─┐
│あ│い│ │お│
└─┴─┴─┴─┘
こういうのとか

**デフォルトの名無しさん** · 2013/11/01(金) 17:54:00.33

>>537
table使えば？

**デフォルトの名無しさん** · 2013/11/01(金) 22:42:39.54

@htmlonlyじゃダメなのか？

**デフォルトの名無しさん** · 2013/11/02(土) 17:17:04.47

>>531
俺はヘッダに書くね
実装する時はヘッダから見るし

**デフォルトの名無しさん** · 2013/11/04(月) 13:47:21.10

>>532と>>540、よくどちらも聞くしどちらも一理あるんだけど
どっちがより一般的なのかな。長いものに巻かれたい。

**デフォルトの名無しさん** · 2013/12/17(火) 11:52:10.96

調べても分からなかったので、質問です。
同じ引き数の関数をまとめたいですが、どうすればいいでしょうか？
以下のようにしたいです。(doxygen 1.8.5使用)

関数
-----
bool add_apple(int* out, int in);
bool add_orange(int* out, int in);
bool add_lemon(int* out, int in);
-----
果物を追加する

引き数
　[out] out 出力
　[in] in 入力

戻り値
　成功 true
　失敗 flase