Question

我正在尝试使用Doxygen组一次记录几个类似的功能。我希望这些函数能够共享相同的文档，如示例here中所示。

// @{
//! @brief Some documentation
int func1(void);
int func2(void);
// @}

// @{
//! @brief Some other documentation
int func3(void);
int func4(void);
// @}

但是，当我运行doxygen时，只有第二组在HTML输出中显示@brief消息。我做错了什么，或者这是一个潜在的错误？

注意，我不试图嵌套组，doxygen文档说不允许这样做。

Answer 1

为此，您可以在配置中使用need to have DISTRIBUTE_GROUP_DOC。代码指定为：

//@{
//! Same documentation for both members. Details ...
void func1InGroup1();
void func2InGroup1();
//@}

如果您想为分组的部分命名：

//! @name Group name
//@{
//! Same documentation for both members. Details ...
void func1InGroup1();
void func2InGroup1();
//@}

Answer 2

解决！

要为每个功能组考虑的文档必须在开头大括号之前：

//! @brief Some documentation
// @{
int func1(void);
int func2(void);
// @}

//! @brief Some other documentation
// @{
int func3(void);
int func4(void);
// @}

Answer 3

只是一个想法：当谈到空白时，Doxygen是挑剔的。确保使用'// @ {'而不是'// @ {'。

Answer 4

以防万一，如果有人使用提供的建议无法使它正常工作。从Doxygen 1.8.17开始对我有用的是，不仅启用DISTRIBUTE_GROUP_DOC并将文档移到组降价开始上方，而且将// @{（或//@{）更改为///@{ （分别为///@}）。如果最后一个斜杠和“ @”符号之间有空格，则也可以使用。

为什么Doxygen文档仅出现在多个相邻组的最后一个组中？

4 个答案: