CODEWITHSUNDEEP
objective-ccdoxygen
Jasper Blues
Jasper Blues

Reputation: 28786

Doxygen enum not showing

Is it possible to have doxygen generate docs for an enum declared on one of my class headers? The enum for the property called 'scope' in this link is not showing as a documented type.

Upvotes: 8

Views: 1850

Answers (2)

Jasper Blues
Jasper Blues

Reputation: 28786

Edit your Doxyfile config and set the following: 

SHOW_FILES = YES

. . and then simply add standard document-comments to the enum type.

It will now be linked and documented.

Upvotes: 0

nomann
nomann

Reputation: 2267

According to Doxygen manual here:

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.

Here is an example:

/*! \file MyClass.h
    \brief A brief file description.

    More details
 */

/*! This is an enum */
enum Direction {
    kDirectionRight, /*!< this is right */
    kDirectionLeft,  /*!< this is left */
};

Hope this helps

Upvotes: 6

Related Questions