使用C编写枚举文档时出现问题

Question

我有一个相当奇怪的问题，因为无论我做什么，它似乎都不会记录我的枚举(在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 manual

让我们重复一遍，因为它经常被忽略:要记录全局对象(函数、类型定义、枚举、宏等)，必须记录定义它们的文件。换句话说，至少必须有一个

/*! \file */或a

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

Answer 2

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

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

/*! \defgroup Enumerations Public enumeration types */

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

Answer 3

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