如何使用Doxygen在源代码中记录枚举类值

时间:2017-01-01 13:12:27

标签: doxygen

我正在尝试在* .cpp文件中记录enum class个值:

考虑:

class SomeClass
{
    enum class MyEnum
    {
        val1
    };
};

和* .cpp文件中的out-of-line Doxygen文档:

/*!
 * \class SomeClass
 * ...
 *\

/*!
 * \enum SomeClass:MyEnum
 * This works fine.
 */

/*!
 * \var SomeClass::MyEnum::val1
 * And this does not...
 */

第三条评论部分失败并显示以下消息:

warning: no matching class member found for SomeClass::MyEnum::val1

我尝试过在其他类似问题和答案中提出的许多变化,但无济于事。我可以将enum class设为常规enum,也可以将文档内联到标题中。还有其他选择吗?

1 个答案:

答案 0 :(得分:1)

请尝试以下操作:

class SomeClass
{
    enum class MyEnum
    {
        val1
    };
};

并在cpp文件中:

/*!
 * \class SomeClass
 * ...
 */

/*!
 * \enum SomeClass:MyEnum
 * This works fine.
 */

/*!
 * \var SomeClass::val1
 * And this works now, too...
 */

请注意,我删除了枚举的标记名称。