Question

我注意到doxygen的奇怪行为，其中函数文档将应用于多个函数。例如：

以下示例按预期工作（仅记录function_a）。但是，使用组会导致行为发生变化。

void function_a(void) {}

/** Document function B */
void function_b(void) {}

void function_c(void) {}

对于某个组，文档字符串Document function B将应用于所有3个函数。

/** \name My ABC Functions
 * \{ */

void function_a(void) {}

/** Document function B */
void function_b(void) {}

void function_c(void) {}

/** \} */

有没有办法避免这种情况？
除了拥有该组中所有功能的文档字符串外。

使用Doxygen version 1.8.11

进行修改

Answer 1

这是由我正在参与的项目配置中启用DISTRIBUTE_GROUP_DOC引起的。

默认情况下禁用此功能，禁用可解决此问题。

请参阅：

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.

DISTRIBUTE_GROUP_DOC = YES

如何在适用于所有其他未记录的函数的组中停止docstrings？

1 个答案: