Documentation 让Doxygen在C中记录枚举的问题
我对Doxygen(Mac OS X Snow Leopard上的1.6.1)有一个相当奇怪的问题,不管我做什么,它似乎都不会记录我的枚举。我用C语言编程,并遵循了手册中的说明。这是我的密码:Documentation 让Doxygen在C中记录枚举的问题,documentation,enums,doxygen,Documentation,Enums,Doxygen,我对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 Reques
/**
* \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 */
};
/**
*\enum dccp\u pkt\u类型
*\brief指定可用的DCCP数据包类型
*/
枚举dccp_pkt_类型
{
DCCP_请求=0,/**
根据doxygen手册,它应该产生正确记录的输出,但它不会产生任何结果。我很可能错过了一些简单的东西,如果有人能给我指出正确的方向,我将不胜感激。如果内存正常,除非文件也有文档记录,否则不会显示枚举文档。尝试添加@file节。来自: 让我们重复一遍,因为它经常 忽略:记录全局对象 (函数、typedef、枚举、宏、, 等),您必须在 它们是被定义的。换句话说 言下之意,至少要有一个
/*\文件*/
或
/**@file*/
此文件中的行
我的经验与使用doxygen 1.8.9.1时的
EXTRACT_ALL=NO
和SHOW_INCLUDE_FILES=NO
相同-全局枚举类型未列出或链接,即使/*\文件*/
存在,全局枚举
由文档化的复合结构引用
为了解决这个问题,我最终定义了一个枚举组:
/*!
\定义组枚举
公共枚举类型
*/
对于枚举类型,我使用了
\ingroup Enumerations
将枚举包含在新组中。然后,Doxygen能够从复合结构自动链接到枚举类型。我在1.8.11版中也发现了这一点。一般性评论没有解决这个问题:您对单个枚举值的[Doxygen]注释(可能除了DCCP_保留的“忽略”注释)没有添加任何有用的内容,只是混乱了视图。