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

Question

我正在尝试在 *.cpp 文件中记录一个 enum class 异常值：

考虑：

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

和out-of-line *.cpp 文件中的 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 或将文档内联到 header。还有其他选择吗？

Answer 1

尝试以下操作：

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

并且在 cpp 文件中：

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

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

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

请注意，我删除了枚举的标签名称。

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

How to document enum class values out of line in source with Doxygen

doxygen