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

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

無いので建てた

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

**デフォルトの名無しさん** · 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

**デフォルトの名無しさん** · 2013/12/17(火) 15:33:50.57

\refで参照するようにするとか。

**デフォルトの名無しさん** · 2013/12/17(火) 18:49:21.24

Doxygen使ってるプロジェクトのドキュメントとかを見てみたけど
複数の関数をまとめて表示してるのは全く見つからなかった…

\refはグループ化とかしないと行けないっぽいし若干敷居が高い…
とりあえずバラでドキュメント化しておくよ
どうもでした

**デフォルトの名無しさん** · 2013/12/18(水) 16:18:20.67

>>542
ところで、それ言語なんなの？

**デフォルトの名無しさん** · 2013/12/19(木) 00:12:07.15

最近はC言語もマイナーになったのかぁ....

**デフォルトの名無しさん** · 2013/12/19(木) 10:13:56.97

>>545
C++だけど何か変か？
もちろんサンプル用にその場で書いただけなんだけど

**デフォルトの名無しさん** · 2013/12/19(木) 12:58:14.64

>>547
少なくとも>>545のコードはへん

**デフォルトの名無しさん** · 2013/12/19(木) 12:58:46.35

>>542だった

**デフォルトの名無しさん** · 2013/12/19(木) 13:52:30.20

もうちょっと分かり易く書くと

bool add_apple(Fruits* fruits, int add_num); // 成功 true 失敗 false
bool add_orange(Fruits* fruits, int add_num);
bool add_lemon(Fruits* fruits, int add_num);

C++なのに第一引き数にオブジェクトの指定が必要だけど、
別に変ではないよ

**デフォルトの名無しさん** · 2013/12/19(木) 14:29:38.26

いや変

**デフォルトの名無しさん** · 2013/12/19(木) 15:26:51.69

変なのは分かったから、ちゃんと具体的に言えないの？

**デフォルトの名無しさん** · 2013/12/19(木) 16:21:36.49

君に使う時間ないし
強烈に変だと思ったからそれだけ伝えたかっただけ

**デフォルトの名無しさん** · 2013/12/19(木) 16:29:15.77

あ、でもFruitsの定義とbool add_apple()の定義を書くというなら、そのコードのどこがおかしいかは指摘できる

**デフォルトの名無しさん** · 2013/12/19(木) 16:35:13.03

スレ違い

**デフォルトの名無しさん** · 2013/12/19(木) 17:05:53.26

逃げたw

**デフォルトの名無しさん** · 2013/12/19(木) 17:49:31.89

まあC++の天才と謳われた俺に書かせれば
bool add ( string fruits_type, Fruits* fruits, int_add_num )
かな。

かなりスマートな設計になっているのが分かると思う。

**デフォルトの名無しさん** · 2013/12/19(木) 17:54:43.58

なるほど。

**デフォルトの名無しさん** · 2013/12/19(木) 18:00:35.80

Fruits fruits;
fruits.add("apple", 10);
とかするのが普通な気もするが。

**デフォルトの名無しさん** · 2013/12/19(木) 18:44:41.90

bool add_apple(Salud* salud, int add_num); // 成功 true 失敗 false
も定義しておけば、

Salud salud;
Fruits fruits; // Salud と継承関係はない

add_apple(salud, 10);
add_apple(fruits, 10);

と出来るメリットもあるので、一概にどれがいいとは言えない
状況による

**デフォルトの名無しさん** · 2013/12/19(木) 18:55:55.95

>>546 >>547 >>550 >>552 >>557 >>559

＞失敗 flase
これじゃね？

**デフォルトの名無しさん** · 2013/12/19(木) 19:10:25.11

まさかそんなあからさまなtypoに対して
「ところで、それ言語なんなの？」なんてドヤ顔でレスするのは想像の範囲外だわ

**デフォルトの名無しさん** · 2013/12/19(木) 22:42:48.16

>>562
こういうのも「嘘を嘘と」の一環じゃねえかと思うんだが

**デフォルトの名無しさん** · 2013/12/20(金) 11:37:29.60

>>561
> これじゃね？
違うよ

> 「ところで、それ言語なんなの？」なんてドヤ顔でレスするのは想像の範囲外だわ
一見C++なんだが、俺の知らない言語の可能性もあるので聞いた

>>560
> 状況による
まあ確かにそうなんだが、俺の見立てではどんな状況でも糞

> Salud salud;
> Fruits fruits; // Salud と継承関係はない
>
> add_apple(salud, 10);
> add_apple(fruits, 10);
も糞だ

**デフォルトの名無しさん** · 2013/12/20(金) 12:59:40.53

設計思想を語りないなら他に行ってくれ。
まぁ、相手にされないからこんなニッチなところで管巻いているんだろうけど。

**デフォルトの名無しさん** · 2013/12/20(金) 13:28:10.11

>>565
別に語りたくないし

変な物を変だと言う自由もないのかこのスレは

**デフォルトの名無しさん** · 2013/12/20(金) 13:30:26.58

まあ、どこの誰かもわからん俺みたいな奴に変だの糞だの言われても、
自分に絶対の自信があれば無視しとけばいいだけの話だよ

**デフォルトの名無しさん** · 2013/12/20(金) 17:58:21.57

まあ、上のコードとか見ると
doxygen 使う以前にもっと読みやすいコードを書く練習しろよとは思う。
doxy られても読む気がしなそうだぜ。

**デフォルトの名無しさん** · 2013/12/20(金) 19:08:41.10

まぁとりあえず、4回も5回もどうでもいい書き込みしなくても
どう糞なのかを1回書き込んでくれれば、それでいいんだよ

**デフォルトの名無しさん** · 2013/12/21(土) 01:52:05.13

flase対するツッコミだったほうがまだマシだったよーな・・・

**デフォルトの名無しさん** · 2013/12/24(火) 21:04:18.14

とりあえずVC++のMFCで書くとしたら、こうするかな。

// Fruit.h
class CFruit : public CObject {
public:
virtual CString GetName() const =0;
};
// Apple.h
#include "Fruit.h"
class CApple : public CFruit {
public:
virtual CString GetName() const { return(_T("Apple")); }
};
// Orange.h
#include "Fruit.h"
class COrange : public CFruit {
public:
virtual CString GetName() const { return(_T("Orange")); }
};
// Lemon.h
#include "Fruit.h"
class CLemon : public CFruit {
public:
virtual CString GetName() const { return(_T("Lemon")); }
};
// FruitBasket.h
#include "Fruit.h"
#include <afxtempl.h>
typedef CTypedPtrArray <CObArray,CFruit *> CFruitPtrArray;
class CFruitBasket : public CFruitPtrArray;

**デフォルトの名無しさん** · 2013/12/24(火) 21:04:57.14

// 続き

int main()
{
CFruitBasket objBasket;
CFruitPtrArray arr;

objBasket.Add(new CApple);
objBasket.Add(new COrange);
objBasket.Add(new CLemon);
arr.Add(new CApple);
arr.Add(new COrange);
arr.Add(new CLemon);
objBasket.Append(arr);

for(int nIndex=0;nIndex<objBasket.GetSize();nIndex++)
{
cout << "\r\nobjBasket[" << nIndex << "]=";
cout << (LPCTSTR)objBasket.GetAt(nIndex)->GetName();
}
}

**デフォルトの名無しさん** · 2013/12/25(水) 08:11:12.01

Doxygen 1.8.6 age
http://www.stack.nl/~dimitri/doxygen/manual/changelog.html#log_1_8_6

**デフォルトの名無しさん** · 2014/06/05(木) 19:26:21.40

C++11のfinalキーワードに対応してないからクラス名が変になる
多分overrideにも対応してない

**デフォルトの名無しさん** · 2015/05/21(木) 18:22:09.52

Windows7でdoxywizardを使ってドキュメントを生成しているのですが、
出力されたログを見るとどうもすべての標準出力が先に出力され
その後に標準エラーがまとめて出力されているようです。

コマンドプロンプトから実行した時のように
標準出力でも標準エラーでもプログラムが出力した順に
出力されるようにしたいのですがどうすればよいでしょうか？

**デフォルトの名無しさん** · 2015/06/15(月) 20:30:40.25

>>575
Doxywizardを使わなきゃいいんじゃね?w

**デフォルトの名無しさん** · 2015/06/15(月) 20:39:41.35

ある関数の概要って、どこに書けばいい？
関数の前に書くの？

**デフォルトの名無しさん** · 2015/06/15(月) 23:06:52.06

>>577
他にどこと迷うのさ？

**デフォルトの名無しさん** · 2015/06/16(火) 08:42:20.29

>>577
うちの場合、宣言がある場合はその直前、ないなら定義の直前。

**デフォルトの名無しさん** · 2015/06/28(日) 09:58:03.15

ヘッダに書く派とソースに書く派の論争は
ドキュメントコメントが生まれたときから続いてるからな

**デフォルトの名無しさん** · 2015/06/30(火) 14:43:18.51

Qtはソースに書いてあって、Doxygenはヘッダに書いてある。

ヘッダとソースだとソースの方が長くなるので、ヘッダに書く派の気持ちはわかる。
でも俺はソースに書いてる。

**デフォルトの名無しさん** · 2015/06/30(火) 14:46:20.40

あと、ヘッダに実装も書く派が増えてきてるので、それはヘッダに書いたほうが良い理由になるかもしれない。
まあ別に、全然関係ないファイルに書いてもいいんだけど。

**デフォルトの名無しさん** · 2015/06/30(火) 15:11:32.39

それでも俺がソースに書く理由は、ヘッダを索引に使ってるから。

本の目次に概要が一緒に書いてあったら50ページくらいに分量になって索引の役に立たないみたいな感じ。
今のエディタは、上に索引が付いてるし、クラスビューもあるから意味ないのかも。

でも、プルダウンリストって読みにくいんだよね。

**デフォルトの名無しさん** · 2015/06/30(火) 19:27:21.11

>>583
なるほど。俺は昔からヘッダをマニュアルとして使っていたから
その流れでdoxygenを知って俺のためのツールだと歓喜したよ。

なので今でもヘッダに書く派なんだよね。
PHPとｂｩやるときはいｂﾂもむずむずすｂ驕B

**デフォャ泣gの名無しさｂ** · 2015/12/10(木) 12:30:07.04

非常にフォルダが細分化されていてとてもinputに手動で登録したくない数なんだけど自動で階層降りてって全部ソース拾ってくれる機能ないの？

**デフォルトの名無しさん** · 2015/12/10(木) 13:40:54.08

すみません自己解決しました

**デフォルトの名無しさん** · 2016/01/12(火) 11:39:36.74

>>586
それは本当に自己で解決したのか？
偉大なる先人の知恵を拝借したのではないのか？

**デフォルトの名無しさん** · 2017/03/06(月) 12:02:40.45

C++で function_>.html というファイルを作ろうとしてエラーになる
回避策を教えておくれ

環境は Windows 版バイナリ 1.8.13

**デフォルトの名無しさん** · 2017/03/06(月) 12:54:45.02

> の文字が、ファイル名として使えないのかな？

**デフォルトの名無しさん** · 2017/03/06(月) 13:29:51.18

>>589
そう
Windowsでは使えない
多分 operator function 用のファイル名に
こういうファイル名を使おうとするんじゃ無いかと思う

SHORT_NAME を有効にすれば変わるかとも思ったんだけど
変化なかった

**デフォルトの名無しさん** · 2017/03/06(月) 13:39:05.08

macのひとか

**デフォルトの名無しさん** · 2017/07/07(金) 13:08:28.11

ひとかたまりにコメントをつけたいんだけど
どうしたらいい？

**デフォルトの名無しさん** · 2017/07/07(金) 13:14:53.42

http://www.doxygen.jp/grouping.html#memgroup

**デフォルトの名無しさん** · 2017/07/07(金) 13:48:38.31

>>593
ありがとう

ついでに
構造体のビットフィールドを図にしたいんだけど
doxygenじゃやってくれない？

**デフォルトの名無しさん** · 2017/07/21(金) 10:58:46.71

入出力に構造体やクラスがあるとき
「このメンバーを使います」というのを明示したいんだけど
どうしたらいい？

**デフォルトの名無しさん** · 2017/12/18(月) 16:09:28.76

>>263,269

**デフォルトの名無しさん** · 2018/05/23(水) 21:02:28.55

僕の知り合いの知り合いができたパソコン一台でお金持ちになれるやり方
役に立つかもしれません
グーグルで検索するといいかも『ネットで稼ぐ方法　モニアレフヌノ』

GIUEM

**デフォルトの名無しさん** · 2018/07/05(木) 00:52:22.57

WZ1

**デフォルトの名無しさん** · 2018/08/21(火) 21:29:50.55

スレタイのコンソメは何？

**デフォルトの名無しさん** · 2019/02/07(木) 00:33:49.07

2、3時間迷った。
Private変数が出ないから。
これは罠だな。
https://i.imgur.com/N4ZDw3L.jpg