Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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.

like image 595
Jasper Blues Avatar asked Dec 07 '13 11:12

Jasper Blues


1 Answers

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

like image 158
nomann Avatar answered Sep 21 '22 15:09

nomann