Doxygen:在几个嵌套组中对类进行分组

时间:2016-10-31 13:41:27

标签: c++ doxygen

我打算在Doxygen组中包含一些记录的C ++类(比如说 let postString = "username="+txtUsername.text! + "; password="+txtPassword.text! request.httpBody = postString.data(using: String.Encoding.utf8) )(比如说AClass),而那个组是另一组(比如说GROUP_C) ,第二组进入另一组,基础组(简称GROUP_B)。像这样:

GROUP_A

我正在尝试为这种情况获得一份干净而合乎逻辑的文档,但是,就像我看到的那样简单,我还没有找到比Doxygen官方文档更具体的内容,其中没有任何关于任何周期性的说法分组问题。但是,只是对上面的简单代码进行处理,就会出现这样的问题:

/** \addtogroup GROUP_A */
/** @{ */

/** \defgroup GROUP_B */
/** @{ */

/** \defgroup GROUP_C */
/** @{ */

/// Comment
class AClass
{
};

/** @} */

/** @} */ 
/** @} */

我也在warning: Refusing to add group GROUP_C to group GROUP_B, since the latter is already a subgroup of the former 文档下获得了生成模块的奇怪面包屑迹象:

enter image description here

有人知道我在Doxygen的嵌套组系统中理解错误了吗?

提前致谢!

2 个答案:

答案 0 :(得分:1)

自从旧版本的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.


  /** @} */  

答案 1 :(得分:0)

不幸的是,您的示例在doxygen-1.8.8和最新的master git分支上按预期工作。警告不会出现。 您是否可能在测试运行中包含其他源文件(而不是显示的示例代码),并且其他文件包含导致组结构中的圆圈的冲突\ defgroup或\ addgroup语句?

关于那个" GROUP_A"下面加倍线" AClass Class Reference" - 我想这只是一个doxygen bug。