doxygen - 将整个标题内容添加到 Doxygen 组

Question

由于这似乎是一项很常见的任务，我很难相信如果我想将头文件中的所有 doxygen 注释添加到一个组中，我必须这样做

foo.h
 /**
 *\addtogroup fooGroup
 * @{
 */
...
...

...
/**@}*/

有没有办法在没有 @{ 评论的情况下完成这项工作？

Answer 1

最简洁的答案是不。另一种方法是使用 @ingroup命令。如果您将该命令放在 @file 正下方命令，然后将文件引用添加到组中，例如:

foo.h:
/**
* @file foo.h
* @ingroup fooGroup
*/
...

这还要求您定义了一个具有该名称的组(也可以在不同的文件中):

/**
* @defgroup fooGroup Foo
* @brief    A brief description of the Foo component.
* @details  A more detailed description of the Foo component.
*/

但最大的缺点是你必须把 @ingroup您要在组文档中显示的每个实体的命令。这意味着您必须将命令添加到每个声明或定义中，例如枚举、结构、变量和函数。

使用 @addtogroup和 @{ ... @}命令的一大优势是您无需使用 @ingroup 将每个实体添加到组中。命令。

组的含义是从一个特定名称下的不同文件中收集文档。您还可以将一个文件分成不同的组，因此 @{ 和 @} 注释定义了应添加到组名称的区域的开头和结尾。
另一个原因是组可能会建立层次结构，例如一个包含以下代码的文件:

/**
 * @addtogroup group_name
 * @{
 */

<Code Example 1>

/** 
 * @} 
 */

/**
 * @addtogroup group_name_2
 * @{
 */

<Code Example 2>

/**
 * @addtogroup sub_group_name
 * @{
 */

<Code Example 3>

/**
 * @addtogroup sub_sub_group_name
 * @{
 */

<Code Example 4>

/** 
 * @} 
 */

/** 
 * @} 
 */

/** 
 * @} 
 */

这将导致以下组层次结构:

组名

group_name_2

子组名称

sub_sub_group_name

您可能会尝试的唯一方法是为\addtogroup 和 { 命令添加别名，例如:

ALIAS += "begingroup{1} = \addtogroup \1 \{"

但在这种情况下，您仍然需要在文件末尾添加 @} 命令。