如何使用Doxygen組鏡像C目錄結構？

Question

我需要一些在C代碼上使用Doxygen的基本幫助。所有的基本文檔都很好，我想要幫助構建一長串冗長的文件和功能。

我有一個C源代碼樹，看起來像這樣：

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

很標準。目前doxygen生成所有文件的平面文件列表。我們將src /的每個dub-dir稱爲「模塊」，因此記錄這看起來像是適合Doxygen模塊/組的好看。

究竟應該如何使用分組命令來鏡像上面的目錄結構？我想在生成的文檔中有一個模塊util，它鏈接到file1和file2文檔。完全像JavaDoc會處理一個包。

添加/ addtogroup util & @ {爲每個頭文件標記生成一個小站點，在所有頭文件中包含所有數據結構的扁平列表等，這不是我所期望的或想要的。也許這就是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. 

這些意見當然可以包含在一個文件還是很多的。通常我會將@page file1放在file1.h中，@page file2放在file2.h等中，而@subpage放在更高層的頭文件或主源文件中。