doxygenを使用する環境について

質問

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.

回答No.2

noname#29459

対象ソースがビルド可能か、どうかは、doxygen処理に関係しません。

しかしながら、doxygen処理をするには、それにあった、コメント記述が必要であり、そのコメント記法も @をつかったjavadoc形式と、\ をつかった、Qt形式があります。どちらで、しょりするのかは、そのソースコード用のconfigファイル(デフォルトは、doxyfile)または、コマンドオプションで指定します

お礼

ご回答ありがとうございます。
ビルドの可否は関係ないんですね、でも
ライブラリの中の型を使用している場合などには、
そのヘッダーファイルが存在しなければ、詳細な
情報まではドキュメント化できないのでは？などと
思ってしまいます。このあたりは設定ファイルで
調整するのかな

4ファイルしか読み込まれないという問題は、以下のような
状況です。

EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO

を全てYESに変えてみたところ、他のファイルも
読み込まれるようになりました。
読み込まれるようになったというよりは、読み込まれた後に
オプションでドキュメント化しない。となっていたようです。。。

回答No.1

katouka09

ソースファイルに記述しているコメントの入れ方に問題があるのではないでしょうか？
参照URLを見て参考にしてみてください。

参考URL：

http://www.doxygen.jp/docblocks.html

お礼

ご回答ありがとうございます。

自分の設定ファイルの設定方法がまずかったようです。

EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO

を全てYESに変えてみたところ、他のファイルも
読み込まれるようになりました。
読み込まれるようになったというよりは、読み込まれた後に
オプションでドキュメント化しない。となっていたようです。。。