GNOME Bugzilla – Bug 561228
Wrong documentation generated for enum
Last modified: 2015-01-01 10:55:19 UTC
Please describe the problem: typedef enum AccountDescriptor { ///NoDescriptor NoDescriptor///1 ///PrimaryAccount ,PrimaryAccount///2 ///SecondaryAccount ,SecondaryAccount///3 }AccountDescriptor; Steps to reproduce: 1. Please look at the comments created by Doxygen for the code provided Actual results: Enumerator: NoDescriptor NoDescriptor. 1 PrimaryAccount PrimaryAccount SecondaryAccount. 2 SecondaryAccount 3 Expected results: Enumerator: NoDescriptor NoDescriptor. PrimaryAccount PrimaryAccount. 2 SecondaryAccount SecondaryAccount. 3 Does this happen every time? Yes Other information:
I think this is a misinterpretation of how the documentation works. Documentation after a variable (that ended already) has to be done by means of //!< and the documentation before the element can be done by means of /// but e.g. the element NoDescriptor ends at the ,(comma) so the ///PrimaryAccount is still seen as belonging to NoDescriptor So I think the correct formulation would be: typedef enum AccountDescriptor { ///NoDescriptor NoDescriptor,//!< 1 ///PrimaryAccount PrimaryAccount, //!< 2 ///SecondaryAccount SecondaryAccount//!< 3 }AccountDescriptor; See also the documentation paragraph 4.1 Special comment blocks (and paragraph 4.1.1.2 Examples)