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.
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
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With