问题是让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

使用EXTRACT_ALL=NO和SHOW_INCLUDE_FILES=NO使用doxygen 1.8.9.1的经验是相同的- 即使/*! \file */存在全局枚举类型也未列出或链接,并且全局enum由记录的复合结构引用.

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

/*! \defgroup Enumerations Public enumeration types */

对于我曾经\ingroup Enumerations在新组中包含枚举的枚举类型.然后,Doxygen能够从化合物结构自动连接到烯醇类型.