Doxygen: Numerische Enum-Werte anzeigen, ohne CSS zu ändern?

Ich brauche eine Möglichkeit, Doxygen dazu zu bringen, den tatsächlichen Wert des Enumerationsmitglieds in der Doxygen-Ausgabe anzuzeigen. Ich habe zum Beispiel:

///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;

Die Ausgabe ist:

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

Was ich will ist:

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

Oder etwas ähnliches.

Es gibt keine Möglichkeit, dies direkt von Doxygen aus zu tun, an die ich denken kann. Doxygen ist kein C-Compiler. Es wird also nicht den Wert einer Aufzählung ableiten, die eine Kompilierzeitkonstante ist.

Das Nächste, was Doxygen tun kann, ist Erweitern Sie Ihre Makros selektiv da es einen C-Präprozessor hat. Wenn Sie also einer Konstante einen Wert zugewiesen haben, der durch Präprozessorerweiterung abgeleitet wurde, kann doxygen die Makros erweitern und Ihnen zeigen, was zugewiesen wird.

Aufbauend auf der Antwort von TheCodeArtist könnten Sie erwägen, ein Skript zu schreiben, das vor doxygen ausgeführt wird, Kopien Ihrer Dateien erstellt und nach diesem Muster sucht:

enum *** {
    ***, ///< %VAL%:

und ersetzt jedes Vorkommen von %VAL% durch den Wert, den Sie haben sollten, damit Sie nicht manuell mit den Zahlen Schritt halten müssen. Nachdem doxygen ausgeführt wurde, müssten die Originaldateien, die die %VAL%-Token enthalten, ersetzt werden. Das ist keine besonders elegante oder robuste Lösung.

Mit doxygen können wir dokumentieren:

• Der enum
• Es ist Werte
• A Beschreibung von jedem Wert

Das folgende Code-Snippet beschreibt ein Beispiel für alle 3 oben genannten.

/*! \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*/

Beachten Sie auch, dass die Erweiterung von Makros/Enumerationen NICHT innerhalb von Doxygen-Kommentaren erfolgt. Wenn in einem Doxygen-Kommentar welche verwendet werden, müssen sie mit erweitert werden INPUT_FILTER. Zum Beispiel:

INPUT_FILTER = sed /MY_ENUM_0/0

ist für das folgende Code-Snippet erforderlich

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

Überprüfen Sie dies auch antworten Einzelheiten zu den verschiedenen Doxygen-Kommentarstilen:

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