c++ - Doxygen:在函数内移动静态变量文档

考虑以下代码:

#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是MyNamespace页面

中的“函数”(很奇怪!)

如何标记SUCCESS和ERROR_UNKNOWN出现在Error类描述页面中？

注意:我的组列表被冻结(我希望每个库一个组)，因此我无法定义一个新的组并同时放入两个组。 “隐藏”组可能是解决方案。

最佳答案

到目前为止，我能找到的最好的“解决方案”是使用\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移动到Error类描述的“静态公共(public)成员函数”下。这不是很好，因为它们随后与其他真正的静态公共(public)成员函数混合在一起。但是也要添加\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移动到Error类描述的“相关函数”下的“错误值”部分中，并带有漂亮的注释报告(Note that these are not member functions.)...。

关于c++ - Doxygen:在函数内移动静态变量文档，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/42666546/