Dokumentowanie wartości enum z doxygen

Question

Dane:

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 
     } 
    } 
} 

a domyślny Doxyfile wykonane z doxygen -g, otrzymuję to:

Jak mogę uzyskać wartości enum udokumentowane? Próbowałem wstawić komentarz przed/po członku, używając ///<, itp., Bezskutecznie. Czy to może być błąd w doxygen? Przykłady w pracy docs. (Kliknięcie na nazwę wyliczenia nie przynosi mnie wszędzie)

Answer 1

Z Doxygen 1.8.2, zarówno dla mnie następujące prace:

Korzystanie ///

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

Korzystanie /*! ... */

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

doxygen changelog mówi, że enum class jest obsługiwana w Doxygen 1.8.2, więc podejrzewam, że może być jakiś drobny problem składni w poleceniach. Czy mógłbyś porównać swoje polecenia z powyższymi dwoma opisami?

Nowe funkcje

Dodano wsparcie dla C++ 11:

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

Answer 2

mieszek styl działa dla mnie:

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

Answer 3

Zauważ, że ja osobiście nienawidzę mieć pliki nagłówkowe, które są długotrwałe (ponieważ dokumentowanie oznacza pisanie co najmniej 2 lub 3 linii dokumentacji, n jedno słowo, więc generalnie nie mam wystarczająco dużo z krótkim opisem, więc wolę dokumentować w pliku .cpp.

Do tego służy funkcja \ var Doxygen.

więc nagłówek przychodzi goły:

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

a plik .cpp posiada:

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. 
*/ 

} 

ten sposób można naprawdę udokumentować na długości co zdarza się często do mnie.