Re: [Doxygen-users] documenting class enum outside of class definition
Brought to you by:
dimitri
|
From: Heather M. <my...@si...> - 2011-09-09 14:05:45
|
All,
I found the section in the documentation that explains documenting class enums, sorry for not checking
there first. However, I'm still not getting my enum documented. So now I'm thinking it is probably due to
a setting in my config file. We put everything in groups, we don't extract all.
Here's the declaration of the class in my actual header:
// Application status enum for helping application-developers
// with backward compatibility of attdefs
class Model_EXPORT AttDefApplicationStatus {
public:
enum Value {
Inherited = 0, // placeholder for image defs
Active,
Obsolete
};
};
and the actual *.cc:
#include "AttDefTypes.h"
/*! \class AttDefApplicationStatus
\ingroup GM
Application status class with enumeration type. This
enumeration can help application-developers with backward
compatibility for attribute definitions
*/
/*! \enum AttDefApplicationStatus::Value
\ingroup GM
Value enumeration type for attribute definition status
*/
/*! \var AttDefApplicationStatus::Value AttDefApplicationStatus::Inherited
\ingroup GM
Inherited attribute definitions
*/
/*! \var AttDefApplicationStatus::Value AttDefApplicationStatus::Active
\ingroup GM
Active attribute definitions
*/
/*! \var AttDefApplicationStatus::Value AttDefApplicationStatus::Obsolete
\ingroup GM
Obsolete attribute definitions
*/
I get the following warnings:
Warning: Documentation for undefined enum `Value' found.
Warning: documented function `AttDefApplicationStatus::Value AttDefApplicationStatus::Inherited' was not
declared or defined.
Warning: documented function `AttDefApplicationStatus::Value AttDefApplicationStatus::Active' was not
declared or defined.
Warning: documented function `AttDefApplicationStatus::Value AttDefApplicationStatus::Obsolete' was not
declared or defined.
Any ideas?
Thanks,
Heather Myers
|