Doxygen 分組

Question

我有一個關於 doxygen 中的頁面和組的問題。 我有一個項目，我用@defgroup 和@ingroup cmds 對類等進行分組。 到目前為止，這工作正常。

現在我想用降價頁面向項目添加特殊文檔。 這些頁面應出現在專用模塊（組）中。 我嘗試使用 @page 和 @subpage cmds 創建頁面。 這工作正常，但頁面在菜單中顯得很簡單。

所以我嘗試使用@ingroup 將它們添加到組中。 但這並不像我猜的那樣工作。 是否可以向模塊（組）添加頁面？

結果應如下所示：

Project
|-- Modules
| |-- "Module1"
| | |-- documentation page1 (from *.md file)
| | |-- class documentation
| |-- "Module2"
| | |-- documentation page2
| | |-- class documentation

我希望你能幫幫我！

Answer 1

在描述的情況下，我們有兩種類型的組文檔：

1. 源文件中的文檔
2. Markdown 文件中的文檔

我們需要為這個組創建樹結構。

例如，我們創建 2 個組：

1. 帶有源代碼文檔的主應用程序
2. 在文件library.md文檔庫

主應用程序組源代碼（用於 C++）可能如下所示：

/** @defgroup app Main Application */

/** @addtogroup app
  * @brief Main application description.
  *
  * @{
  */

int main() { return 0; } //do nothing

/** @} */

MarkDown 文件library.md包含簡單的文本：

Library File {#library}
============

Library Page Content from library.md.

現在定義結構，我們創建帶有內容的mainpage.md文件：

Pages {#mainpage}
============

Content:

- @subpage library

@defgroup Library
@addtogroup Library
@copydoc library
@{
@}

mainpage.md 中的@subpage標簽用於隱藏從樹到一個根項目（頁面）的所有頁面。 @defgroup標記為降價文檔創建新組。 @copydoc標簽將內容從庫頁面復制到庫組。

在屏幕截圖上，您可以看到結果結構：

請注意，在這種情況下，模塊組名稱和頁面名稱可能不同。 您還可以使用@copydoc標簽將 MarkDown 文件中的內容粘貼到源代碼文檔中。

參考： http : //www.doxygen.nl/manual/grouping.html

Answer 2

我已經使用 @{ 和 @} 命令完成了它，它的工作原理是這樣的 -

/**  
 * @defgroup module_name Sample Module   
 * @{   
 *     @page page_name [Optional Page Heading]   
 *     here will be the texts for the page ...    
 * @}   
 */   

如果您已經在某處定義了模塊，則可能需要使用@addtogroup 而不是@defgroup。

希望這可以幫助。