C'è un modo per ottenere doxygen per mostrare valori numerici enum senza cambiare css?

Question

Voglio ottenere il valore reale del membro enum nell'output doxygen. Per esempio ho:

///MyEnum 
typedef enum My_Enum 
{ 
MY_ENUM_0,///<MY_ENUM_0 
MY_ENUM_1,///<MY_ENUM_1 
MY_ENUM_2 ///<MY_ENUM_2 
} My_Enum; 

L'output è:

MyEnum. 
Enumerator: 
MY_ENUM_0 
     MY_ENUM_0. 
MY_ENUM_1 
     MY_ENUM_1. 
MY_ENUM_2 
     MY_ENUM_2. 

Quello che voglio è:

Enumerator: 
MY_ENUM_0 
      0 MY_ENUM_0. 
MY_ENUM_1 
      1 MY_ENUM_1. 
MY_ENUM_2 
      2 MY_ENUM_2. 

o qualcosa di simile.

Answer 1

Usando doxygen, possiamo documentare:

• I enum
• sue valori
• Un descrizione di ciascun valore

Il frammento di codice seguente descrive un esempio per tutti e 3 sopra.

/*! \enum My_Enum 
* Documentation of the enum type. 
*/ 

typedef enum My_Enum { 
    MY_ENUM_0, /*!< Document the value 0 */ 
    MY_ENUM_1, /*!< Document the value 1 */ 
} My_Enum; 

/*! \var My_Enum MY_ENUM_0 
* The description of the MY_ENUM_0. Can contain its enumerated name */ 

/*! \var My_Enum MY_ENUM_1 
* The description of the MY_ENUM_1. Can contain its enumerated name*/ 

---

Si noti inoltre che, poiché l'espansione macro/enum non avviene entro i commenti Doxygen. Se alcuni sono utilizzati all'interno di un commento doxygen, devono essere espansi utilizzando INPUT_FILTER. Per esempio:

INPUT_FILTER = sed /MY_ENUM_0/0 

è necessario per il seguente frammento di codice

typedef enum My_Enum { 
    MY_ENUM_0, /*!< MY_ENUM_0 */ 
    ... 

---

anche Checkout Questo answer per i dettagli sul doxygen più stili commentando:

• ///< <comment>
• /*!< <comment> */