我打算AClass在 Doxygen 组(假设)中包含一些记录的 C++ 类(假设)GROUP_C,而该组包含在另一个组(假设GROUP_B)中,而第二组包含在另一个基类(假设GROUP_A)中。像这样:
/** \addtogroup GROUP_A */
/** @{ */
/** \defgroup GROUP_B */
/** @{ */
/** \defgroup GROUP_C */
/** @{ */
/// Comment
class AClass
{
};
/** @} */
/** @} */
/** @} */
Run Code Online (Sandbox Code Playgroud)
我正在尝试为这种情况获得一个干净且合乎逻辑的文档,但是,正如我所看到的那样简单,我无法找到比 Doxygen 官方文档更具体的内容,其中没有提及任何循环分组问题。然而,仅仅对上面的简单代码进行 doxygen 处理,就会出现这样的问题:
warning: Refusing to add group GROUP_C to group GROUP_B, since the latter is already a subgroup of the former
Run Code Online (Sandbox Code Playgroud)
我还在文档下得到了生成模块的奇怪面包屑指示AClass:
有人知道我对 Doxygen 嵌套组系统的理解有什么问题吗?
提前致谢!
自旧版本的 Doxygen 以来,这个解决方案一直为我工作多年:
/** \defgroup GROUP_A My top-level group description
*
* Put here a longer description.
*
**/
/** @addtogroup GROUP_B My group B description
* \ingroup GROUP_A
* @{ */
// classes, etc.
/** @} */
/** @addtogroup GROUP_C My group C description
* \ingroup GROUP_B
* @{ */
// classes, etc.
/** @} */
Run Code Online (Sandbox Code Playgroud)