Doxygen将多个功能分配给类

时间:2018-07-01 15:03:18

标签: doxygen

我正在尝试使用doxygen记录我的库的C接口。所有功能都分组在一个虚拟类中,并分配了运算符\memberof。由于功能很多,我想用组运算符@ {分配多个功能。

/**
* \class Base
*/

/**
* \class Derived
* \extends Base
*/

/**
* \memberof Base
* @{
*/

/**
* \brief Function A
*/
void Base_A();

/**
* \brief Function B
*/
void Base_B();

/** @} */

这将为派生类创建页面,如下所示:

enter image description here

出于某种原因,继承成员有两个部分-公共继承成员和相关成员。我认为这两个功能应该在同一类别中。

向每个函数添加\ memberof命令似乎可以解决问题。

/**
* \class Base
*/

/**
* \class Derived
* \extends Base
*/

/**
* \brief Function A
* \memberof Base
*/
void Base_A();

/**
* \brief Function B
* \memberof Base
*/
void Base_B();

enter image description here

有人可以确认这是 bug 吗?

有人可以向一个班级提供多个功能的工作组分配吗?我有数百种功能,添加这么多命令是不可行的。

1 个答案:

答案 0 :(得分:0)

我毫不犹豫地将其称为错误。 \{ \}命令旨在与\ ingroup,\ defgroup,\ addtogroup,\ weakgroup等分组命令一起用于分组,在这种情况下,它与\ memberof一起使用。

它看到\memberof命令并“分配”下一个符合“基本”要求的功能:

  

此命令使函数成为类的成员,其方式类似于\ relates,仅使用此命令   函数表示为类的真正成员。当编程语言执行此操作时可能会很有用   本身不支持成员函数的概念(例如C)。

它似乎忽略了\{\}