让 Doxygen 在 C 中记录枚举的问题

Question

我对 Doxygen（Mac OS X Snow Leopard 上的 1.6.1）有一个相当奇怪的问题，因为无论我做什么，它似乎都没有记录我的枚举。我正在用 C 语言进行编程，并按照手册中的说明进行操作。这是我的代码：

/**
 * \enum dccp_pkt_type 
 * \brief specifies the available DCCP packet types
 */

enum dccp_pkt_type
{
    DCCP_REQUEST    = 0,    /**< DCCP Request Packet */
    DCCP_RESPONSE,          /**< DCCP Response Packet */
    DCCP_DATA,              /**< DCCP Data Packet */
    DCCP_ACK,               /**< DCCP Ack Packet */
    DCCP_DATAACK,           /**< DCCP Data Ack Packet */
    DCCP_CLOSEREQ,          /**< DCCP Close Request Packet */
    DCCP_CLOSE,             /**< DCCP Close Packet */
    DCCP_RESET,             /**< DCCP Reset Packet */
    DCCP_SYNC,              /**< DCCP Sync Packet */
    DCCP_SYNCACK,           /**< DCCP Sync Ack Packet */
    DCCP_RESERVED,          /**< DCCP Reserved Packet Type - Receivers MUST
                         ignore any packets with this type */
};

它应该根据 doxygen 手册生成正确记录的输出，但它什么也没生成。我很可能错过了一些简单的事情，如果有人能指出我正确的方向，我将不胜感激。

Answer 1

来自 Doxygen 手册：

让我们重复一遍，因为它经常
被忽视：记录全局对象
（函数、typedef、枚举、宏、
等），您必须将文件记录在
它们是被定义的。在其他方面
也就是说，至少必须有一个

<代码>/*! \file */ 或 a

/** @file */ 此文件中的行。

Answer 2

我的经验与在 doxygen 1.8.9.1 中使用 EXTRACT_ALL=NO 和 SHOW_INCLUDE_FILES=NO 的体验相同 - 即使 /*! 全局枚举类型也没有列出或链接。 \file */ 存在，并且全局enum 由记录的复合结构引用。

为了解决这个问题，我最终定义了一个枚举组：

<代码>/*!
\defgroup 枚举
公共枚举类型
*/

对于枚举类型，我使用 \ingroup Enumerations 将枚举包含在新组中。然后，Doxygen 能够从复合结构自动链接到枚举类型。

Answer 3

如果内存正常，则不会显示枚举文档，除非该文件也已记录。尝试添加 @file 部分。