Doxygen組和模塊索引

我正在爲我的項目創建一個Doxygen文檔。最近，我使用\addtogroup標籤對相關類進行分組。在此之後，我的文檔中有一個模塊選項卡。它顯示所有模塊。我想在模塊名稱下方的模塊名稱下面添加一些說明，位於同一頁面上。我如何使用Doxygen做到這一點？Doxygen組和模塊索引

這裏是我的標籤

/*! \addtogroup test test 
* Test Testing a group in doxygen 
* @{ 
*/

來源

2010-03-30 cppdev

你必須寫一個僅包含註釋的專用.h文件中。對於每個組定義這樣的評論：這樣

/** @defgroup FooGroup 
* 
* This module does yada yada yada 
* 
*/

然後分配定義的組（甚至在不同的文件）：

/** @addtogroup FooGroup */ 
/*@{*/ 

/** Summon a goat 
* 
* @param name The name of the goat; 
* @return The summoned goat; 
*/ 
Goat summon_goat (const char *name); 

... 
... 

/*@}*/

編輯：

而且this是如何變成的。請參閱「詳細說明」？您還可以在@verbatim和@endverbatim命令中添加代碼段和示例。

來源

2010-08-04 16:19:24 Dacav

「召喚一隻山羊」讓我感到吃驚。順便說一句，SourceForge鏈接似乎截至2011年9月28日中斷。 – Adrian 2011-09-28 20:43:17

@Adrian，更新後的鏈接。感謝您的報告。 – Dacav 2011-09-29 08:50:33

請注意，您不需要單獨的頭文件來執行此操作。你可以把'@ defgroup'放在與@ addtogroup相同的文件中，或者根本不需要'@ defgroup'，只需將文本放入'@ addtogroup'塊中的一個（它們的工作原理與'@ defgroup'）。訣竅是，爲了讓文本顯示在模塊頁面的頂部（以及模塊索引頁面），它必須是簡要描述（即'@ brief'），而其他任何內容都將顯示在「詳細信息」下說明「進一步下降。 – Foogod 2015-12-21 23:53:29

Doxygen組和模塊索引

回答

相關問題