c - cssを変更せずにdoxygenにenum数値を表示させる方法はありますか?

Question

doxygen 出力で enum メンバーの実際の値を取得したいと考えています。たとえば、私は持っています：

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

出力は次のとおりです。

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

私が欲しいのは：

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

または似たようなもの。

Answer 1

doxygen を使用すると、以下を文書化できます。

• のenum
• その値
• 各値の説明

次のコード スニペットは、上記の 3 つすべての例を示しています。

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

---

また、マクロ/列挙型の展開は doxygen コメント内では行われないことに注意してください。doxygen コメント内で使用されている場合は、 を使用して展開する必要がありますINPUT_FILTER。例えば：

INPUT_FILTER = sed /MY_ENUM_0/0

次のコード スニペットに必要です

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

---

また、複数の doxygen コメント スタイルの詳細については、この回答を確認してください。

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