2011-06-14 85 views
12

我想在doxygen文檔中包含文件夾。如何在doxygen文檔中包含文件夾?

我試過\頁和\包括但它沒有工作,有誰知道如何做到這一點?這裏是樹:

+0

這是有用的:http://comments.gmane.org/gmane.text.doxygen.general/8425? – 2011-06-14 08:10:33

+0

我想知道文件夾包含什麼。圖片?需要記錄的類?要包含的HTML文件? – cweiske 2011-06-14 10:51:22

+0

@cweiske該文件夾包含需要記錄的類 – 2011-06-14 12:30:28

回答

19

要添加到您的問題的意見,\ page命令將頁面添加到您手動編寫的文檔。即如果源文件包含\ page聲明,則它會將內容添加到文檔索引。您可以在此處添加額外的幫助,例如:

/*! \page overviewpage Architecture Overview 
* 
* \section memorymanagement Memory Management 
* 
* Some writing you want to appear as a help page in the documentation here. 
*/ 

\ include命令將包含文件的副本作爲源代碼塊。

我想你實際上是問你如何讓Doxygen添加多個源目錄。只要遞歸設置爲YES,這不是默認設置,如果您已將根文件夾設置爲Doxygen輸入,則它應該適用於您的結構。

RECURSIVE    = YES 

如果你還沒有,你可以添加像這樣的不同文件夾,路徑相對於Doxyfile文件。

#--------------------------------------------------------------------------- 
# configuration options related to the input files 
#--------------------------------------------------------------------------- 

# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
# with spaces. 

INPUT     = src test/src 
相關問題