Question

考虑以下代码：

#include <string>

namespace MyNamespace
{

/** \brief Error Class */
class Error
{
public :
    /** \brief Constructor */
    Error ( int in_code, const std::string& in_message );
    ...
};

/** \brief Successfull result */
static Error SUCCESS(                                   0, "Success. " );
/** \brief Error of unknown kind, used internally only to identify a pending result */
static Error ERROR_UNKNOWN(                             1, "Unknown Error. " );
...

};

MyNameSpace已经是doxygen组的一部分。当我生成文档时，我得到：

Error班级描述的一页
SUCCESS和ERROR_UNKNOWN是＆＃34;功能＆＃34; （{1}页

如何标记MyNamespace和SUCCESS以显示在ERROR_UNKNOWN班级描述页面中？

注意：我无法定义新组并将其放入，因为我的组列表已冻结（我们希望每个库有一个组）。＆＃34;隐藏＆＃34;小组可以解决。

Answer 1

到目前为止，最好的＆＃34;解决方案＆＃34;我发现是使用\memberof。

此：

/** \memberof Error @{ */

/** \brief Successfull result */
static Error SUCCESS(                                   0, "Success. " );
/** \brief Error of unknown kind, used internally only to identify a pending result */
static Error ERROR_UNKNOWN(                             1, "Unknown Error. " );
...

/** @} */

将SUCCESS和ERROR_UNKNOWN移动到＆＃34;静态公共成员函数＆＃34; Error类描述。这不是很好，因为它们与其他真正的静态公共成员函数混合在一起。但是也添加了\name标记......

/** \memberof Error @{ */
/** \name Error values: */

/** \brief Successfull result */
static Error SUCCESS(                                   0, "Success. " );
/** \brief Error of unknown kind, used internally only to identify a pending result */
static Error ERROR_UNKNOWN(                             1, "Unknown Error. " );
...

/** @} */

将SUCCESS和ERROR_UNKNOWN移动到＆＃34;错误值＆＃34; ＆＃34;相关功能＆＃34; Error类的描述，有一个很好的Note报告(Note that these are not member functions.) ....这绝对是可以接受的......

Answer 2

在代码中，SUCCESS和ERROR_UNKNOWN 不是是Error类的一部分，因此生成的文档是纠正（抛弃“功能”的问题）。

尝试使doxygen显示它们作为Error类的一部分是非常误导的，因为文档和代码现在是矛盾的。

如果您真的希望SUCCESS成为Error类的一部分，请在代码中进行此操作。

或者，这可能是Error类文档中的意图，添加@see SUCCESS，@see ERROR_UNKNOWN等评论。

这将生成“另请参阅”注释，指向这些项目的文档。

Doxygen：在函数内移动静态变量文档

2 个答案: