09/06/02 06:08:56
>>212
たしかに、前後に空白で正しく表示されます。
本当に適用したいソース(再現用ソースでない)でもうまく表示されます。
ありがとうございました。
214:デフォルトの名無しさん
09/06/02 23:53:16
>>195
今のdoxywizardはver.1.5.8(去年の暮れ頃)からですね。
基本的な設定項目だけのwizardモードと、
設定可能な項目が全部表示されるexpertモードの2本立てというのは
昔も今も変わりませんが、
設定を変えたら保存しないと実行できなかったとか、
設定項目のセクション切り替えがタブで、expertモードだと
たくさん並んでるのをぐるぐるスクロールさせる必要があったとか、
細かいところで少し不便でした。
マニュアルに載ってるスクリーンショットは旧バージョンのような気がします。
215:デフォルトの名無しさん
09/06/02 23:58:29
doxygenで、1カ所に書いたコメントを複数箇所で参照する方法はありますか?
例えば、
hoge.h内で@version 1.1.1
という記述が同じhoge.h内で他にも複数箇所に登場する場合、
全部に@version 1.1.1と書いてしまうとバージョンを上げる時に
全箇所を手動で修正する羽目になってしまいます。
どうにかする手段はありますか?
216:デフォルトの名無しさん
09/06/03 02:07:50
>>215
設定ファイルのALIASESで@version 1.1.1に別名をつければ、
バージョンを上げるときはそこだけ変えればOK
というのはどうでしょう?
217:デフォルトの名無しさん
09/06/03 03:43:33
質問です。
いままでのプログラムは以下のようにコメントしていたのですが、
doxygenでは/** */の形式にしないとドキュメント作成はできないのでしょうか?
コメント部分を目立たせたいので、できれば今までのコメント形式を維持したいのですが・・
今までのコメント例
//********************************************************
// Test.cpp
// 2009.09 by Tester
// テスト用のクラス
//********************************************************
これを
/**
*
*
*
*/
形式にするのは少し抵抗があります
218:デフォルトの名無しさん
09/06/03 08:40:05
>>217
特定の形式にしないと、ドキュメントにしないコメントと区別できないですからね……
使えるコメント形式はマニュアルの「Documenting the code」にいろいろ例があります。
(日本語マニュアルは古くて少し情報が少ないです)
今までのに比較的近いのは
/*****************************************************//**
* Test.cpp
* 2009.09 by Tester
* テスト用のクラス
*********************************************************/
でしょうか。
219:デフォルトの名無しさん
09/06/03 10:41:33
>>217
最初と最後の //****** はそのままで、途中の行だけ先頭の//を3文字にすればいい
220:デフォルトの名無しさん
09/06/03 10:48:32
つまり、こうだな。
//********************************************************
/// \file Test.cpp
/// \date 2009.09
/// \author Tester
/// \brief テスト用のクラス
//********************************************************
221:デフォルトの名無しさん
09/06/03 16:06:28
>>217
俺も抵抗があったけど、
変えてみたら意外と平気だったよ。
要は見慣れるかどうか。
222:デフォルトの名無しさん
09/06/03 16:09:51
>>216
ALIASES
なんてものがあるのですね。
ありがとうございます、試してみます。
223:デフォルトの名無しさん
09/06/03 22:23:44
>>218-221 thanks
ですが、ファイルの最初のコメントを
//********************************************************
/// \file Test.cpp
/// @file TEST.cpp
//********************************************************
と色々やってみたのですがうまくいきませんでした・・
ファイルの最初だと///ではドキュメント化されないのでしょうか
クラス宣言前や関数前では///で書いたコメントはちゃんとドキュメント
のコメントとなっておりました。
ちなみに、ファイル一覧からコードを見るとなぜか明朝体?で表示されてしまいます。
以下のドキュメントのようにゴシック表示をしたいのですが、Font設定はどのようにすればよいでしょうか?
URLリンク(www.ee.t-kougei.ac.jp)
224:デフォルトの名無しさん
09/06/03 22:57:41
追加で質問失礼。
Player.hの内容↓
/** @brief クラスの簡易説明
* このクラスの使用目的・使用方法など詳しい情報を書く。
* @todo 必要であれば記述
* @bug バグがあれば記述
*/
#if !defined (__PLAYER_H__)
#define __PLAYER_H__
class CPlayer
{
...
}
というプログラムだと、インクルードガードのほうに
マクロ定義
#define __PLAYER_INFO_BASE_H__
クラスの簡易説明 * このクラスの使用目的・使用方法など詳しい情報を書く。
というドキュメントが付いてしまうのですが、
インクルードガードは一番上に書かなければいけないのでしょうか?
できればファイルに関するコメントを一番上に記述したいのですが・・・
225:デフォルトの名無しさん
09/06/03 23:10:52
さらに追加質問ですいませんorz
出力されたドキュメントは任意の名前のフォルダに作成されますが、
index.htmlが他の細かいファイルと一緒のフォルダにあるため探しづらいです。
そのため、index.htmlだけ残して他のファイルを別のフォルダに押し込む
というようなフォルダ構成を構築したいのですが、そういったことは可能でしょうか?
226:デフォルトの名無しさん
09/06/03 23:33:53
>>223
ファイルの最初のコメント:
ファイル名の大文字・小文字の問題かもしれません。
ファイル名無しで @file だけにしてみてはどうでしょうか。
フォント:
フォントはデフォルトのスタイルシートで、
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
と設定されてるので、
特にカスタマイズしてなければゴシックで表示されるはずなんですが。
>>224
対象を指定しないドキュメントは、直後にあるものに関連づけられます。
ファイルに関するコメントにしたいなら、@file が必須です。
227:デフォルトの名無しさん
09/06/04 08:53:01
>>224
本題とは直接関係ないと思いますが、ドキュメントに「 * 」が入ってるのが気になりました。
コメント行頭の「 * 」のところ、全角スペース使ってませんか?
228:デフォルトの名無しさん
09/06/04 23:00:02
>>226-227
thanks.
一度doxygenを全削除して再インストールしたら
なんとかファイル要約関連のコメントはでるようにできました。
229:デフォルトの名無しさん
09/06/05 00:21:06
また質問なのですが、
以下のような複数行について同じコメントをつけたい場合は
何かうまい記述法はありますか?
例:
/// 3D座標を示す値.
int nX;
int nY;
int nZ;
このままですと、nXだけにコメントがついてしまうため、
3つの変数全てに同じコメントを出すようにしたいのですが・・・
int nX;///< 3D座標を示す値x.
int nY;///< 3D座標を示す値y.
int nZ;///< 3D座標を示す値z.
これだと冗長な感じでちょっと抵抗があります
230:デフォルトの名無しさん
09/06/05 02:50:49
っ nameタグ
231:デフォルトの名無しさん
09/06/05 09:01:35
>>229
普通は、一つのコメントで括られるような変数は構造体に入れるもんじゃね?
232:デフォルトの名無しさん
09/06/05 19:33:13
>>231
おお、良いこと言った!
233:デフォルトの名無しさん
09/06/05 22:02:00
>>231
座標とかだと、配列の方が扱いやすいかも
構造体の方が見やすいけどね
234:デフォルトの名無しさん
09/06/06 08:55:20
C++ code - 50 lines - codepad
URLリンク(codepad.org)
これからdoxygenでhtmlドキュメントを生成させると、
メンバ一覧のページの上にある目次の部分は
すべてのメンバ一覧
Public メソッド
void foo (bool)
void foo (short)
void foo (int)
void foo (long)
void foo (double)
void bar (bool)
void bar (short)
void bar (int)
void bar (long)
void bar (double)
となります。このように並ぶと微妙に見づらいので
すべてのメンバ一覧
Public メソッド
foo系のメンバは
void foo (bool)
void foo (short)
void foo (int)
void foo (long)
void foo (double)
bar系のメンバは
void bar (bool)
void bar (short)
void bar (int)
void bar (long)
void bar (double)
の様にコメントをこの場所に入れたいしたいのですが、可能でしょうか?
235:デフォルトの名無しさん
09/06/06 09:13:44
>>234
マニュアルの「Grouping」(日本語版マニュアルだと「グループ化」)のページを見てください
236:デフォルトの名無しさん
09/06/06 09:55:14
>>235
それで出来るのですね。
ありがとうございます。見てきます。
237:デフォルトの名無しさん
09/06/06 11:53:22
doxygenで作ったthtmlドキュメントの
若干ながらフォントサイズが小さすぎると感じます。
このフォントサイズを大きくすることはできますか?
238:234
09/06/06 20:44:39
C++ code - 17 lines - codepad
URLリンク(codepad.org)
とりあえずこの様にしてみました。
/** document former */
がメンバ関数全部について、
/** document latter */
がメンバ関数void func_1_InGroup1()だけにつくかと期待したのですが、
結果は
void Test::func_1_InGroup1に
document former document latter
と付いただけでした。
どこが誤っているでしょうか?
よろしくお願いいたします。
239:234・238
09/06/06 20:56:51
C++ code - 26 lines - codepad
URLリンク(codepad.org)
とりあえずこれで行けそうです。
・・・法則性がわからない。
240:デフォルトの名無しさん
09/06/06 22:29:27
法則性はその>>238と>>239の違いの@nameの有無の部分ですよ。
マニュアルより:
ブロックの開標識の前に、独立したコメント・ブロックを置くこともできます。
このブロックは、@name (または、\name) コマンドを含む必要があり、
グループのヘッダーを指定します。
そうしたければ、グループに関するより詳しい情報をコメント・ブロックに
含めることもできます。
241:239
09/06/06 22:36:14
>>240
doxygen用語の理解が今ひとつ足りなかったようです。
親切にありがとうございました。
242:デフォルトの名無しさん
09/06/07 12:54:49
Use built-in class diagram generator
だと継承に関するクラス階層図がうまく表示されますが、
Use dot tool from the GraphViz package
だとうまく表示されません。
このようなHTMLになってしまいます。
URLリンク(loda.jp)
(これには再現する簡単なソースとDoxyfile、出来上がったHTMLが含まれています。)
環境はWindows XP SP2で、
doxygenはdoxygen-1.5.9-setup.exeを使ってインストールしました。
GraphVizはgraphviz-2.22.2.msiを使ってインストールしました。
GraphVizの問題だとしたら若干スレ違いかもしれませんが、
よろしくお願いいたします。
243:242
09/06/07 13:43:31
C++ code - 25 lines - codepad
サンプルソースが腐ってたので
URLリンク(codepad.org)
これでお願いします。
244:デフォルトの名無しさん
09/06/07 23:01:58
>>242-243
DOT_FONTSIZEが小さい(デフォルト値は10)のが気になりますが、
正直なところデフォルト設定と余りに違いすぎて、それだけなのかどうかは何とも。
もしこだわって作りこんだ設定でないのなら、一度デフォルト設定に戻して、
最低限必要なところだけ変えるようにしてみてはどうでしょう?
デフォルト設定にはメニューから[Settings]→[Reset to factory defaults]で戻せます。
245:デフォルトの名無しさん
09/06/08 00:35:20
>>242
どこを問題視したいのか判らんが、HAVE_DOTがNOだからクラス階層図が出ないのは当たり前なんだが。
つーか、>>244も含めて
Doxyfile位真面目に読んでくれ。
246:242
09/06/08 06:55:17
>>244-245
ありがとうございます。
教えを頼りに読んできます。
247:244
09/06/08 08:39:21
>>242, >>245
>>242のドキュメントではdotファイルが吐かれてるし、
クラス階層図はdotファイルの内容どおりに生成されてます。
文字が読めないのはフォントサイズが4のためです。
コラボレーション図はdotにノードがなぜか出力されてませんが、
画像ファイル自体は真っ白なのが存在していて、
dotファイルの内容どおりには生成されているといえます。
なので、これらはHAVE_DOT=YESの状態で生成されたはずです。
DoxyfileはHAVE_DOT=YESにする前に保存したものと思われます。
dotの中身が異常なので、ほかに問題があると思います。
248:デフォルトの名無しさん
09/06/08 15:59:54
Doxygenて
__declspec(dllexport) int WINAPI MyFunc(int arg);
とか、それを簡略化して
#define API(type) __declspec(dllexport) type WINAPI
とした場合に
API(int) MyFunc(int arg);
みたいな宣言もちゃんと処理してくれる?
249:242
09/06/08 16:17:43
>>247
ありがとうございます。
全然こだわって作りこんだ設定ではありませんので、
デフォルトに戻すことに抵抗はありません。
いろいろ教えの通り試してみます!
250:デフォルトの名無しさん
09/06/08 22:09:14
URLリンク(appleloader.bbsnow.net)
Exportタブに何も表示されないのですがバグですか・・・?
ノートPCでは表示されました
両方 WinXP 32bit SP3 です
251:デフォルトの名無しさん
09/06/08 22:48:53
>>248
__declspec()は関数と誤認識されるので、
PREDEFINED で __declspec(x)= を定義するなどして、
プリプロセス時に取り除いてやる必要があります。
(マニュアルの「Preprocessing」に書かれてます)
252:デフォルトの名無しさん
09/06/08 23:24:43
>>250
eeepc + winxp でやってるけど、ウチも全く同じ現象になるよ。
253:250
09/06/09 19:08:32
レスありがとう。
じゃあエクスポートタブの設定はできないのですかね・・・?
日本語マニュアルを作成したいので以下の設定をしたいのですが
設定する箇所は2箇所です。まずProject内にある「OUTPUT_LANGUAGE」をJapaneseにします。これで日本語マニュアルが作成されます。ただ、このままだと文字化けが起こります。
続いて、Inputの中にあるINPUT_ENCODINGに「CP932」と文字を打ちます。CP932というのはMicrosoftなどが拡張したShift-JIS文字コードです。Visual Studioなどのソースコードはこの文字コードを指定するとDoxygenでうまく読み込んでくれます。
改善方法分かる人いたらアドバイスください よろしくお願いします
254:デフォルトの名無しさん
09/06/09 19:38:26
>>253
設定内容を保存したファイルはテキストなので、直接編集できますよ。
255:250
09/06/09 19:54:02
>>254
お!
ありがとうございます
256:デフォルトの名無しさん
09/06/09 21:16:16
>>255
念のため。
PROJECT_NAME 等に日本語を使ってる場合、UTF-8で保存されてるので気を付けて。
257:デフォルトの名無しさん
09/06/11 21:35:53
doxygen20090611.zip - uploader_nrnrnr
URLリンク(loda.jp)
このaaaaaa.hとDoxyfileからdoxygenでhtmlドキュメントを生成させると、
aaaaaa.h
ソースコードを見る。
マクロ定義
#define ABS(x)
#define MAX(x, y)
#define MIN(x, y)
#define MYMACRO "表示されたくない。"
このように表示されるのですが、私は最後の
#define MYMACRO "表示されたくない。"
を
#define MYMACRO
の様にしたいと思っております。
また、各マクロの説明文にある
値:~~
というのも非表示にしたいと思います。
どうすればよろしいでしょうか?
258:デフォルトの名無しさん
09/06/11 22:23:30
関数テンプレートなどの
テンプレート引数を出力する項目は作れませんか?
259:デフォルトの名無しさん
09/06/12 01:24:59
>>257
MAX_INITIALIZER_LINES を 0 にするのはどうでしょう?
変数の初期値なども全部表示されなくなりますが。
260:デフォルトの名無しさん
09/06/12 01:58:14
>>258
@tparamで出来るらしいです。
261:258
09/06/12 08:02:39
>>260
ありがとうございます。
助かります。
262:257
09/06/12 19:21:47
>>259
MAX_INITIALIZER_LINESを0にする方法でいけそうです。
ありがとうございます。
263:デフォルトの名無しさん
09/06/12 19:54:28
doxygenの公式サイト(英語版)
が見たいのだが、リンクが死んでいる気がする。
それとも単に落ちただけだろうか?
264:263
09/06/12 23:59:05
単に落ちただけだったようだ。
勝手に騒いでスマソ。
265:デフォルトの名無しさん
09/06/20 18:37:54
保守
266:デフォルトの名無しさん
09/06/20 21:38:29
Windows XP SP2, doxygen 1.5.9です。
Sample.h
URLリンク(codepad.org)
これでhtmlドキュメントを生成させますと、
クラス階層図(継承関係)
が表示されません。
class Sample は std::runtime_error をpublic継承しているので
この継承の様子をGraphVizでグラフ表示させたいと思っているのですが、
どうすればよろしいでしょうか?
ソースとDoxyfile、出来上がったHTMLは
URLリンク(loda.jp)
です。
同じDoxyfileを使っても、関数の呼び出し関係は
うまくGraphVizでグラフ化されて表示されています。
よろしくお願いいたします。
267:デフォルトの名無しさん
09/06/20 22:08:18
>>266
HIDE_UNDOC_RELATIONS が YES だからじゃないかと思いますが、
NO にしてもライブラリからの継承まで図に含めてくれるかどうか。
INCLUDE_PATH にコンパイラのヘッダファイルのパスの設定もして試してみてください。
268:266
09/06/20 23:31:56
>>267
HIDE_UNDOC_RELATIONS
をNOにしたところ、
> INCLUDE_PATH にコンパイラのヘッダファイルのパスの設定
これをしなくても希望通りになりました。
URLリンク(imagepot.net)
感謝感激です。
どうもありがとうございました。
269:デフォルトの名無しさん
09/06/26 21:24:59
保守
270:デフォルトの名無しさん
09/07/02 07:40:28
>>250
どうもパネル作成時のミス?のようです。
Exportタブの中身はWizardタブと同じように左右分割されているらしく、
「左側の何も無いパネル」「右側の設定パネル」という風になっています。
それで「左側の何も無いパネル」の幅が最大になっているため、
何も表示されていないように見えるようです。
マウスを右端に移動させるとカーソル形状が変化しますので、
そのまま左にドラッグすると設定内容のパネルが見えるようになりました。
271:270
09/07/03 02:55:10
少し訂正
左右分割だけではなく左側が上下に分割された3ペイン方式でした。
「左側の何も無いパネル」のように見えるますが下のほうに移動してるだけでした。
270と同じように下から上にドラッグすると表示物が見えるようになります。
272:デフォルトの名無しさん
09/08/08 18:05:25
保守
273:デフォルトの名無しさん
09/08/08 18:32:18
Windows XP SP2, doxygen 1.5.9です。
URLリンク(loda.jp)
このSample.hを同じくこのDoxyfileで
HTMLドキュメント化したのですが、
文字サイズが小さくて困っております。
DOT_FONTSIZE = 100
FORMULA_FONTSIZE = 100
の様にしてみても、フォントサイズが変わりません。
sakura-editor: クラス CDlgCancel
URLリンク(sakura-editor.sourceforge.net)
ここにあるような
文字サイズにしたいのですが、どうすればよろしいでしょうか?
よろしくお願い申し上げます。
274:デフォルトの名無しさん
09/08/08 20:32:24
>>273
ドキュメント見てみたけど普通の文字サイズだと思うけど。
そういえば最近のバージョンはちょっと前のより文字サイズ小さいかも。
DOT_FONTSIZE はグラフの文字サイズ、FORMULA_FONTSIZE は式の文字サイズです。
文字サイズを変えるにはスタイルシートをカスタマイズすることになると思う。
やったことないけど、マニュアルによると、
doxygen -w html header.html footer.html stylesheet.css
でデフォルトのファイルを出力して、それを書き換えて
Doxyfile の HTML_STYLESHEET でそのファイルを指定するらしいです。
275:273
09/08/08 21:27:14
>>274
その方法で解決できました。
文字サイズは見る人によって好みがあると思っていましたので、
stylesheet.cssのフォントサイズ指定の部分を削除しました。
これにより人によって好みの文字サイズにブラウザ側で変更できるようになりました。
(前はブラウザ側でも文字サイズの変更が(通常操作の範囲では)できませんでした。)
どうもありがとうございました。
276:デフォルトの名無しさん
09/08/12 12:31:12
Doxygen
で表を表示する方法を教えてください。
URLリンク(www.doxygen.jp)
ここの<table>タグ以外にはありますか?
277:デフォルトの名無しさん
09/08/12 12:45:02
Doxygenはドキュメント生成ツールであってドキュメント記述言語ではないから
適宜表は表示されるよ。例えば関数一覧とかファイル一覧とか。
任意の表を記述したいと言うことなら話は別で。
元々html自体に表を記述するタグはtable以外にはないに等しいからねぇ。
横方向に高々2カラムしかないなら<ul>などで代用できなくもないけれど。
278:276
09/08/12 13:14:58
>>277
ありがとうございます。
良さそうなのでもうすこしマニュアルを読み込んできます。
279:デフォルトの名無しさん
09/08/14 02:53:06
>>276-278
私も任意の表をお手軽に作る方法はないかなと思ってました。
今ふと思いついたんですが、関連のタグの組み合わせをALIASESで簡略化したらちょっとはマシかも。
280:デフォルトの名無しさん
09/08/21 00:30:09
保守
281:デフォルトの名無しさん
09/08/22 01:18:19
Doxygen 1.6.0 age
282:デフォルトの名無しさん
09/08/22 16:54:46
Doxygen 1.6.0で何か変わったことある?
設定とかは変わってないよね?
また設定しなおしとか嫌よ。