Documentare valori enum con doxygen

Question

Dato:

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

E il default Doxyfile fatto con doxygen -g, ottengo questo:

Come posso ottenere i valori enum documentati? Ho provato a mettere il commento prima/dopo il membro, usando ///<, ecc, senza alcun risultato. Potrebbe essere solo un insetto in doxygen? Gli esempi nei documenti funzionano. (Cliccando sul nome della enum non mi porta da nessuna parte)

Answer 1

Con Doxygen 1.8.2, sia il seguente lavoro per me:

Utilizzando ///

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

Utilizzando /*! ... */

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

Il doxygen changelog dice che enum class è supportato in Doxygen 1.8.2, così ho il sospetto ci può essere qualche problema di sintassi minore in comandi. Potresti confrontare i tuoi comandi con i due snippet precedenti?

nuove funzionalità

Aggiunto il supporto per C++ 11:

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

Answer 2

Lo stile soffietto funziona per me:

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

Answer 3

Nota che io personalmente odio dover file di intestazione che vanno alla grande (perché documentare significa scrivere almeno 2 o 3 linee di documentazione, n di una parola quindi di solito non ho abbastanza con il brief) quindi preferisco documentare nel file .cpp.

Per fare ciò si utilizza la funzione \ var di Doxygen.

Quindi l'intestazione viene nuda:

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

e il file cpp ha:

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

} 

In questo modo, posso davvero documentare a lungo che spesso accade a me.