![](http://oshiete.xgoo.jp/images/v2/pc/qa/question_title.png?5a7ff87)
doxygenでドキュメントを作成しようと思ったのですが、
思うように、ドキュメントが作成されずに悩んでいます。
具体的には、当該プロジェクトを構成するファイルは、沢山
あるのに、doxygenでは4つのファイルだけしかドキュメント化
されていない感じです。
まず、doxygenを使用する環境についてなのですが、
ドキュメント化するソースコードが完全にビルドできる環境で
doxygenを使用する。というのが前提のなのでしょうか?
今はLinux上で動くCUIアプリのソースをWindows XP上で、
ドキュメント化しようとしています。
以下は、doxygenを起動したときのDOS画面上に出るログの中で
Warningとなっていた箇所の抜粋です。
C:/0_data/3_melt/cclive-0.2.5/cclive.h:29: Warning: Compound _mem_s is not docu
ented.
C:/0_data/3_melt/cclive-0.2.5/progress.h:21: Warning: Compound progressbar_s is
not documented.
C:/0_data/3_melt/cclive-0.2.5/dl.c:162: Warning: Compound getdata_s is not docu
ented.
C:/0_data/3_melt/cclive-0.2.5/cclive.h:36: Warning: Compound cclive_s is not do
umented.
C:/0_data/3_melt/cclive-0.2.5/llst.h:21: Warning: Compound _llst_node_s is not
ocumented.
C:/0_data/3_melt/cclive-0.2.5/host.c:433: Warning: Compound host_s is not docum
nted.
C:/0_data/3_melt/cclive-0.2.5/cmdline.c:74: Warning: Compound line_list is not
ocumented.
![](http://oshiete.xgoo.jp/images/v2/common/profile/M/noimageicon_setting_12.png?5a7ff87)
No.2ベストアンサー
- 回答日時:
対象ソースがビルド可能か、どうかは、doxygen処理に関係しません。
しかしながら、doxygen処理をするには、それにあった、コメント記述が必要であり、そのコメント記法も @をつかったjavadoc形式と、\ をつかった、Qt形式があります。どちらで、しょりするのかは、そのソースコード用のconfigファイル(デフォルトは、doxyfile)または、コマンドオプションで指定します
ご回答ありがとうございます。
ビルドの可否は関係ないんですね、でも
ライブラリの中の型を使用している場合などには、
そのヘッダーファイルが存在しなければ、詳細な
情報まではドキュメント化できないのでは?などと
思ってしまいます。このあたりは設定ファイルで
調整するのかな
4ファイルしか読み込まれないという問題は、以下のような
状況です。
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
を全てYESに変えてみたところ、他のファイルも
読み込まれるようになりました。
読み込まれるようになったというよりは、読み込まれた後に
オプションでドキュメント化しない。となっていたようです。。。
No.1
- 回答日時:
ソースファイルに記述しているコメントの入れ方に問題があるのではないでしょうか?
参照URLを見て参考にしてみてください。
参考URL:http://www.doxygen.jp/docblocks.html
ご回答ありがとうございます。
自分の設定ファイルの設定方法がまずかったようです。
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
を全てYESに変えてみたところ、他のファイルも
読み込まれるようになりました。
読み込まれるようになったというよりは、読み込まれた後に
オプションでドキュメント化しない。となっていたようです。。。
お探しのQ&Aが見つからない時は、教えて!gooで質問しましょう!
似たような質問が見つかりました
- BTOパソコン DELLのパソコンの電源を入れたところ 以下のメッセージが出ました 3 2022/09/03 21:18
- C言語・C++・C# C#テキストボックスの文字を配列にいれてその後表示する 4 2022/07/17 04:47
- その他(SNS・コミュニケーションサービス) 自分のpcがハッキングされたようなメールが来たのですがどうすればいいですか? 4 2022/10/02 16:14
- Java 動かなくなったのでJavaソースを手直しお願いします。 2 2022/04/30 05:35
- PHP PHPでユーザー情報を入力して簡易ログイン機能をつくってみたのですが 1 2023/05/29 08:51
- Gmail 【お助け!】サーバーからのメール送信でGmailに送信されない問題について 1 2023/06/20 22:03
- C言語・C++・C# const char** p;のとき、free(p)でC4090エラーとなるのはなぜですか 3 2023/03/31 16:28
- UNIX・Linux Linuxのbash環境下です。 1 2022/11/27 12:31
- C言語・C++・C# 10個の実数に対する降順ソート結果を出力するプログラムを作りたいのですが、以下のプログラムをどう直せ 1 2022/07/09 22:16
- PHP PHPで画像の渡しが上手く行きません。 1 2023/02/02 09:39
関連するカテゴリからQ&Aを探す
デイリーランキングこのカテゴリの人気デイリーQ&Aランキング
-
PHP: 未定義エラーの回避方法を...
-
【PHP】csvファイルへの書き出...
-
While文を使って配列の中身を全...
-
自動で番号を振りたい
-
PHPのfputcsv を使わずにCSVに...
-
C言語でCSVファイルの行数を読...
-
配列同士の足し算のループ処理
-
行数が30万件ほどあるCSVから、...
-
VBAでcsvファイルもシートもあ...
-
ラジオボタンのチェックの付け方。
-
phpメールフォームから送信され...
-
PHPの構文で間違えが分からない
-
PHPは何故値渡しより参照渡しの...
-
STLのvectorで作った配列をメン...
-
c言語 単位行列
-
三重県南部の温泉
-
禁止ワード設定
-
aaa.csvとbbb.csvを条件で抽出...
-
ジャグ配列
-
○番目から○番目までの取り出し...
マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング
-
別ファイルの構造体の値を読み...
-
複数行のデータのPOST処理に関して
-
エラーメッセージ(無効な間接...
-
Resource id #3 と表示されま...
-
ヒアドキュメントの中のfor文
-
自動で番号を振りたい
-
C言語でCSVファイルの行数を読...
-
配列同士の足し算のループ処理
-
stdClass Objectを連想配列のよ...
-
PHPでCSVの一部の行を編集したい
-
phpを実行するとファイルダウン...
-
行数が30万件ほどあるCSVから、...
-
phpでCSVファイルの中身を多次...
-
php Undefined variableエラー
-
CSVデータの行数カウントをした...
-
csvの内容を行単位で削除したい
-
複数ファイルで、それぞれの行...
-
テキストデータから指定行の削除
-
rubyで複数列のデータを一行に...
-
PHP5でCSVの指定行データだけを...
おすすめ情報