2017-01-01 100 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