[英]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.