Doxygenグループを使用してCディレクトリ構造をミラーリングする方法は？

Question

CコードでDoxygenを使って基本的な助けが必要です。すべての基本的なドキュメントがうまく出てきています。長い長いファイルと関数のリストを構造化するのに役立ちたいと思います。

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

非常に標準：

私はこのようになりますCのソースツリーを持っています。現在、doxygenはすべてのファイルのフラットファイルリストを生成します。 src /の「dub-dir」を「モジュール」と呼んでいるので、これを文書化することはDoxygenモジュール/グループに適しているようです。

上記のディレクトリ構造をミラーリングするには、どのようにグループ化コマンドを使用しますか。私はfile1とfile2のドキュメントにリンクされている生成されたドキュメントでモジュールのutilを持っています。 JavaDocはパッケージを扱うのとまったく同じです。

@ addtogroup utilを追加すると、各ヘッダーファイルに@ {tags}タグが付いているため、すべてのヘッダー内のすべてのデータ構造などのフラットなリストが作成されました。おそらく、これはdoxygenグループがやるべきことです。つまり、コードが複数のファイルにまたがって実装されているときにAPIを一様に文書化していますか？

Answer 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. 

これらのコメントはもちろん、一つのファイルまたは多くに含まれていることができます。通常、私はをfile1.hに、@page file2をfile2.hに、そして@subpageをさらにトップレベルヘッダーまたはメインソースファイルに入れます。