集團記錄一組枚舉mebers的

是否可以記錄一組枚舉值，類似於這樣的（這個例子不工作）：集團記錄一組枚舉mebers的

enum MyEnum 
{ 
    MYENUM_FIRST, 
//@{ 
//@name These two members' description 
    MYENUM_SECOND, 
    MYENUM_THIRD, 
//@} 

    MYENUM_FOURTH, ///third member documentation 
    MYENUM_FIFTH 
};

來源

2012-04-13 Alexander Vassilev

兩個直接的東西脫穎而出：

您沒有記錄MYENUM_SECOND或MYENUM_THIRD因爲你還沒有使用有效的Doxygen註釋包裹其中：你應該寫///@{代替//@{。
你的MYENUM_FOURTH文件應
```
///< third member documentation 
```
否則你記錄MYENUM_FIFTH，而不是MYENUM_FOURTH。

我可以使用下面的代碼

enum MyEnum 
{ 
    MYENUM_FIRST, 
    ///@{ 
    /// These two members' description 
    MYENUM_SECOND, 
    MYENUM_THIRD, 
    ///@} 

    MYENUM_FOURTH, ///< third member documentation 
    MYENUM_FIFTH 
};

，並通過配置文件中設置DISTRIBUTE_GROUP_DOC = YES獲得兩個MYENUM_SECOND和MYENUM_THIRD文檔。請注意，我已經從示例中刪除了\name命令。

來源

2012-04-13 12:43:28 Chris

對於那些愚蠢的錯誤，我很抱歉，我把這個例子有點匆忙。我最初的想法是以粗體顯示組上方的標題，而不是爲兩個成員具有相同的文檔，因此是'@name'標籤。在這種情況下，似乎不可能使用'@name'標籤。但擁有相同的文檔也是一個好主意。看起來doxygen允許// @ {和/// @ {，作爲doxygen doc展示的一個例子 - 但也許它們意味着不同的東西？我想發佈示例，但char限制不允許我。 – 2012-04-13 15:23:04

您可以隨時編輯您的問題以添加更多代碼示例。而不是「標題」，爲什麼不記錄'enum'本身？ – Chris 2012-04-13 15:43:46

@WernerHenze這個問題有一個可接受的答案。如果您有其他問題，請創建一個新問題。 – Chris 2017-11-28 13:32:11

集團記錄一組枚舉mebers的

回答

相關問題