Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Issue getting Doxygen to document an enum in C

Tags:

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.

like image 447
Cromulent Avatar asked Nov 11 '09 20:11

Cromulent


1 Answers

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.

like image 92
Tim Henigan Avatar answered Oct 03 '22 14:10

Tim Henigan