Issue getting Doxygen to document an enum in C

Question

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.

General comment not addressing the question: Your [Doxygen] comments for individual enum values (perhaps with the exception of the "ignore" note for DCCP_RESERVED) do not add anything useful, just clutter the view. — Petr Vepřek
– Petr Vepřek, Commented Oct 20, 2017 at 7:17

albert · Accepted Answer · 2018-12-12 10:26:45Z

36

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.

edited Dec 12, 2018 at 10:26

albert

9,2103 gold badges24 silver badges42 bronze badges

answered Nov 11, 2009 at 20:52

Tim Henigan

62.6k11 gold badges87 silver badges79 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Bryan · Accepted Answer · 2015-03-08 18:12:43Z

11

My experience is the same using EXTRACT_ALL=NO and SHOW_INCLUDE_FILES=NO with doxygen 1.8.9.1 - global enum types were not listed nor linked even though /*! \file */ is present and the global enum is referenced by a documented compound structure.

To work around this, I ended up defining an Enumerations group:

/*! \defgroup Enumerations Public enumeration types */

and for the enum types I used \ingroup Enumerations to include the enums in the new group. Doxygen then was able to autolink from the compound structures to the enum types.

answered Mar 8, 2015 at 18:12

Bryan

1111 silver badge2 bronze badges

1 Comment

Wes Over a year ago

I'm finding this too in version 1.8.11.

Stephen Newell · Accepted Answer · 2009-11-11 20:48:32Z

4

If memory serves correctly, enum documentation doesn't show up unless the file is also documented. Try adding a @file section.

answered Nov 11, 2009 at 20:48

Stephen Newell

8,0381 gold badge32 silver badges37 bronze badges

Collectives™ on Stack Overflow

Issue getting Doxygen to document an enum in C

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related