Question

我有以下代码：

/// \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.
};

一切似乎都运行良好（枚举最终在文件范围内，但我有一个\文件，因此它与描述一起显示，格式正确。

我想要（并且没有发生）的是我想在Tick_Data_Row :: m_cols的文档中引用Tick_Column_Type来链接回该文档页面。 Doxygen似乎在弄清楚“啊哈，这是我知道的名字，我将热链接它”时非常聪明，但在这种情况下它没有这样做。

如果我在结构中移动枚举并不重要。

任何线索？

Answer 1

来自the docs (Automatic Link Generation)：需要从

更改

///< The data.  Indexed by Tick_Column_Type.

到

///< The data.  Indexed by ::Tick_Column_Type.

Answer 2

以下内容对我有用。这是我定义枚举的方式-

divmod

这就是我的指称-

/** @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  */
};

如何让Doxygen“链接”到枚举定义？

2 个答案: