代码之家 › 专栏 › 技术社区 › Cromulent

获取doxygen在C中记录枚举时出现问题

doxygen enums documentation

21

Cromulent · 技术社区 · 15 年前

我对doxygen有一个相当奇怪的问题(MacOSXSnowLeopard上是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手册生成适当的文档化输出,但实际上它什么也不生成。我很可能错过了一些简单的事情,如果有人能给我指明正确的方向,我会感激的。

3 回复 | 直到 6 年前

1

35

albert 6 年前

从 Doxygen manual :

让我们重复一遍,因为忽略:记录全局对象 (函数、typedef、枚举、宏, 等),您必须将文件记录在它们是被定义的。在其他话,至少要有一个

/*! \file */ 或A

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

2

8

Bryan 10 年前

我的经验也是一样的 EXTRACT_ALL=NO 和 SHOW_INCLUDE_FILES=NO 使用doxygen 1.8.9.1-全局枚举类型未列出或链接,即使 /*! \file */ 存在于全球 enum 被记录的复合结构引用。

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

/*! \defgroup Enumerations Public enumeration types */

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

3

4

Stephen Newell 15 年前

如果内存工作正常,除非文件也有文档记录,否则枚举文档不会出现。尝试添加@file节。