2017-01-01 56 views
2

我想记录的enum class值出在* .cpp文件行记录枚举类值脱节源:如何使用Doxygen的

考虑:

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

和OUT-下线Doxygen文档在* .cpp文件:

/*! 
* \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

尝试以下操作:

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

和cpp文件:

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

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

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

注意,我去掉枚举的标签名。

+0

谢谢,我在OP中提到了这个选项。它适用于普通的'枚举类型',但不适用于'枚举类'。无论如何,因为我主要使用Qt,所以我放弃了Doxygen并搬到了'QDoc'。 – Resurrection

+0

呵呵,我试了一下我发布的代码,它甚至可以用'enum class'工作。 – gmug

+0

有趣的是,你是对的。这不是非常直观,不会为多个具有相同值的enum类工作,但它是当前Doxygen的答案。 – Resurrection