考虑这段代码:
#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 类描述的“相关函数”下的“错误值”部分，并带有一个很好的注释报告(请注意，这些不是成员函数。)....这绝对是可以接受的...
关于c++ - Doxygen:在函数内移动静态变量文档，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/42666546/