问问Doxygen在C中记录一个枚举 [英] Issue getting Doxygen to document an enum in C

问题描述

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

  / ** 
 * \enum dccp_pkt_type 
 * \brief指定可用的DCCP数据包类型
 * / 
 
 enum dccp_pkt_type 
 {
 DCCP_REQUEST = 0，/ **& DCCP请求包* / 
 DCCP_RESPONSE，/ **< DCCP响应包* / 
 DCCP_DATA，/ **< DCCP数据包* / 
 DCCP_ACK，/ **< DCCP Ack Packet * / 
 DCCP_DATAACK，/ **< DCCP数据确认包* / 
 DCCP_CLOSEREQ，/ **< DCCP关闭请求包* / 
 DCCP_CLOSE，/ **< DCCP关闭数据包* / 
 DCCP_RESET，/ **< DCCP复位包* / 
 DCCP_SYNC，/ **< DCCP Sync Packet * / 
 DCCP_SYNCACK，/ **< DCCP Sync Ack Packet * / 
 DCCP_RESERVED，/ **< DCCP保留数据包类型 - 接收者MUST 
忽略此类型的任何数据包* / 
}; 
  

应该根据doxygen手册产生正确的文档输出，而不会产生任何东西。我很可能错过了一些简单的事情，如果有人能指出正确的方向，我将不胜感激。

解决方案

一个href =http://www.doxygen.nl/docblocks.html =noreferrer> Doxygen手册：

我们重复一遍，因为通常
被忽略：要记录全局对象
（函数，typedefs，枚举，宏，
等），您必须以
定义它们。在其他
字中，必须至少有一个

/ *！ \file * / 或

/ ** @file * / line在这个文件中。

I have a rather odd problem with Doxygen (1.6.1 on Mac OS X Snow Leopard) in that it does not seem to document my enums no matter what I do. I am programming in C and have followed the instructions in the manual. Here is my code:

/**
 * \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 */
};

It should according to the doxygen manual produce properly documentated output but instead it produces nothing. I am most likely missing something simple, if anyone could point me in the right direction I would be grateful.

解决方案

From the Doxygen manual:

Let’s repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a

/*! \file */ or a

/** @file */ line in this file.

这篇关于问问Doxygen在C中记录一个枚举的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！