與doxygen的

Question

文檔化枚舉值給出：

namespace Foo { 
    class Foo { 
    public: 
     /// Foo enum, possible ways to foo 
     enum class Foo { 
      /// Foo it with an A 
      A, 
      /// Foo it with a B 
      B, 
      /// Foo it with a C 
      C 
     } 
    } 
} 

而且用的Doxyfile做出doxygen -g默認，我得到這個：

我怎樣才能得到證明枚舉值？我試着在會員之前/之後發表評論，使用///<等無濟於事。可能這只是doxygen中的一個錯誤？文檔中的示例工作。 （點擊枚舉的名稱不帶我到任何地方）

Answer 1

隨着Doxygen的1.8.2，既爲我以下工作：

使用///

/// This is an enum class 
enum class fooenum { 
    FOO, ///< this is foo 
    BAR, ///< this is bar 
}; 

使用/*! ... */

/*! This is an enum class */ 
enum class fooenum { 
    FOO, /*!< this is foo */ 
    BAR, /*!< this is bar */ 
}; 

的doxygen changelog說enum class在Doxygen的1.8.2的支持，所以我懷疑可能有一些小的語法問題你的命令。您能否將您的命令與上述兩個片段進行比較？

新功能

爲C++ 11新增支持：

strongly typed enums, e.g.: 
enum class E 

Answer 2

波紋管風格的作品對我來說：

enum class Foo { 
    /**Foo it with A*/ 
    A, 
    /**Foo it with B*/ 
    B 
} 

Answer 3

注意，我個人不喜歡有頭文件長（因爲記錄意味着至少寫2或3行文檔，一個單詞，所以我通常沒有足夠的簡短），所以我更喜歡在.cpp文件中記錄。

要做到這一點，您可以使用Doxygen的\ var功能。

所以頭說到裸：

namespace Foo { 
    class Foo { 
    public: 
     enum class Foo { 
      A, 
      B, 
      C 
     }; 
    }; 
} 

和.cpp文件有：

namespace Foo { 

/** \enum Foo::Foo 
* \brief Foo enum, possible ways to foo 
* 
* All the necessary details about this enumeration. 
*/ 

/** \var Foo::A 
* \brief Foo it with an A 
* 
* When you use A... etc. 
*/ 

/** \var Foo::B 
* \brief Foo it with an B 
* 
* When you use B... etc. 
*/ 

/** \var Foo::C 
* \brief Foo it with an C 
* 
* When you use C... etc. 
*/ 

} 

這樣的話，我真的可以記錄在長度經常發生在我身上。