4

C コードで Doxygen を使用する基本的なヘルプが必要です。基本的なドキュメントはすべて問題なく作成されており、ファイルと関数の長い長いリストを構築するのに助けが必要です。

次のような C ソース ツリーがあります。

src/
 +--util/
    +--file1.h
    +--file1.c
    +--file2.h
    +--file2.c
 +--stats/
    +--file3.h
 +--etc/

非常に標準的です。現在、doxygen はすべてのファイルのフラット ファイル リストを生成します。src/ の各 dub-dir を「モジュール」と呼んでいるため、これを文書化することは Doxygen モジュール/グループに適しているようです。

上記のディレクトリ構造を反映するには、グループ化コマンドをどのように使用すればよいですか? file1 および file2 ドキュメントにリンクする、生成されたドキュメントにモジュール util が必要です。JavaDoc がパッケージを扱うのとまったく同じです。

/addtogroup util & @{ タグを各ヘッダー ファイルに追加すると、すべてのヘッダー内のすべてのデータ構造などのフラット化されたリストを含むミニ サイトが生成されましたが、これは私が期待または望んでいたものではありません。おそらく、これは doxygen グループが行うべきことです。つまり、コードが複数のファイルにまたがって実装されている場合に、API を一様に文書化しますか?

4

1 に答える 1

1

モジュールを使用するためのより簡単なオプションは、 と を使用すること@pageです@subpage。説明したレイアウトに似たものを取得するには、次を使用できます。

@page util Util
This page describes util module.
@subpage file1
@subpage file2

@page stats Stats
This page describes stats module.
@subpage file3

@page etc
Blah blah blah

@page file1 File 1
This is file 1.

@page file2 File 2
This is file 2.

@page file3 File 3
This is file 3.

もちろん、これらのコメントは 1 つまたは複数のファイルに含めることができます。通常@page file1、file1.h、@page file2file2.h などに、@subpageコメントをよりトップレベルのヘッダーまたはメイン ソース ファイルに配置します。

于 2011-06-17T00:06:05.933 に答える