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

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

無いので建てた

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

**デフォルトの名無しさん** · 2009/09/16(水) 00:28:43

doxygenで、C++でhtmlドキュメントを作りたい時、
　ここからここまでの範囲のソースはドキュメントしないでね
あるいは
　このクラスはドキュメント化しないでね（ドキュメントに載せないでね）
といった指示はできるのでしょうか？

よろしくお願いいたします。

**デフォルトの名無しさん** · 2009/09/16(水) 03:34:57

>>304
素直な方法は、ドキュメント化したい部分に一通りdoxygen用のコメントをつけて、
EXTRACT_ALL は NO にして、
HIDE_UNDOC_MEMBERS と HIDE_UNDOC_CLASSES を YES にすることでしょうか。

そうすれば、コメントの付いている部分だけがドキュメント化されます。

**デフォルトの名無しさん** · 2009/09/16(水) 07:05:22

>>305
ありがとうございます。
私は
> EXTRACT_ALL は NO にして、
> HIDE_UNDOC_MEMBERS を YES に
まではしているのですが、
HIDE_UNDOC_CLASSES
はNOにしています。
というのも、YESにするとドキュメント化したいクラスが
標準ライブラリや他人のライブラリ(doxygenコメント化されていない)
の中のあるクラスを継承しているクラスであった場合、
継承関係がグラフ化されなくなってしまうからです。

かといってこのままでは実装用のクラスまでも
HTMLドキュメントに出て来てしまうのが
ちょっと気持ち悪いので、悩んでおります。

**デフォルトの名無しさん** · 2009/09/17(木) 01:10:31

>>306

doxyfile で
PREDEFINED = NO_DOXYGEN
としておいて、ヘッダの方で

#ifndef NO_DOXYGEN
実装用クラス
#endif

とか私はやってます。

**306** · 2009/09/17(木) 06:59:25

>>307
ありがとうございます。
そんな方法があったんですね。

**307** · 2009/09/17(木) 16:45:15

>>308

後で見返してよく考えたら「NO_DOXYGEN」だと意味逆でしたね。
まあそれはともかく、この方法を使うと、
たとえば利用者マニュアル用 doxyfile と
内部開発者用 doxyfile とかを使い分けて
(それぞれ別々の PREDEFINED を設定しておく)、
コード内では #ifndef を使ってマニュアルに出したいものを制御
なんてこともできます。

**306** · 2009/09/17(木) 21:03:18

>>309
なるほど、深いですね。
面白そうです。
ありがとうございます。

**306** · 2009/09/18(金) 00:20:10

#ifndef DOXYGEN
実装用クラス
#endif
としてみましたが、
クラス一覧に相変わらず実装用クラスが出力されます。

　doxygen 1.6.1, Windows XP SP2
Doxyfileは
　ttp://loda.jp/uploader_nrnrnr/?id=11
です。

恐れ入りますが、>>307さんのdoxygenのバージョンはいくらでしょうか？

**306** · 2009/09/18(金) 00:20:56

ちなみにちゃんと
#ifndef DOXYGEN
になっています。
#ifdef DOXYGEN
だったりはしません。
よろしくお願いいたします。

**307** · 2009/09/18(金) 01:26:34

>>311-312

doxyfile 拝見しました。
1312 行目の EXPAND_AS_DEFINED の方にマクロ名が記述されて
いるようなんですが、これを 1305 行目の PREDEFINED の方に
記述して試してもらえますか？

ちなみに、私が使用している環境は 1.6.1 で
OS は主に Mac OS X と FreeBSD です。
(一昨日くらいまで 1.5.9 使ってましたけど。)
あ、でも doxyfile は 1.5.8 の時につくったものでした。

**デフォルトの名無しさん** · 2009/09/18(金) 09:44:38

>>312
お前、馬鹿だろw
>307を読めば判ることで何とち狂ってるんだか。

**306** · 2009/09/18(金) 11:12:07

>>313
申し訳ございません。
ご指摘の通り大変みっともない間違いをしでかしており、
恥ずかしいかぎりです。

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