[英]How do I get Doxygen to "link" to enum defintions?
我有以下代码:
/// \file Doxygen_tests.h
/**
*
* \enum Tick_Column_Type
*
* \brief Values that represent Tick_Column_Type.
**/
enum Tick_Column_Type {
TC_OPEN, ///< Opening price
TC_HIGH, ///< High price
TC_MAX, ///< Required as last enum marker.
};
/**
*
* \struct Tick_Data_Row
*
* \brief Holder for one row or snapshot of tick data.
*
**/
struct __declspec (dllexport) Tick_Data_Row {
Tick_Data_Row (); ///< Constructor. Sets all columns to NaN
void init (); ///< Helper function to reset everything to NaN
double m_cols[TC_MAX]; ///< The data. Indexed by Tick_Column_Type.
};
一切似乎都工作正常(枚举最终在文件范围内,但我有一个 \\file,所以它与描述一起出现,格式正确。
我想要(并且没有发生)是我希望在 Tick_Data_Row::m_cols 的文档中引用 Tick_Column_Type 以链接回该文档页面。 Doxygen 通常似乎很聪明地想出“啊哈,这是一个我知道的名字,我会热链接它”,但在这种情况下它没有这样做。
我是否在结构内移动枚举并不重要。
有什么线索吗?
来自文档(自动链接生成) :需要从
///< The data. Indexed by Tick_Column_Type.
到
///< The data. Indexed by ::Tick_Column_Type.
以下对我有用。 这是我定义枚举的方式 -
/** @brief An enumeration
* The return values of all the exported functions of GameEngine.dll
*/
enum GE_RETURN_CODES
{
GE_FUNCTION_WORKED_PROPERLY = 0, /*!< 0 the function worked properly */
GE_ERROR /*!< Other Error - These errors are displayed by the Helper DLL */
};
这就是我提到它的方式 -
* \return returns an #GE_RETURN_CODES value enum
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.