Doxygen enum not showing

Is it possible to have doxygen generate docs for an enum declared in one of the headers of my class? The enumeration for the "scope" property in this link does not appear as a documented type.

+7
c objective-c doxygen
source share
2 answers

Change the Doxyfile configuration and install the following:

SHOW_FILES = YES 

., and then just add standard comments to the enum type.

Now it will be linked and documented .

0
source share

According to the Doxygen guide 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

+4
source share

All Articles