GNOME Bugzilla – Bug 665629
Enum docs cease after #define inside enum
Last modified: 2012-02-25 15:37:29 UTC
Created attachment 202879 [details] Configuration file Doxygen stops generating output for an enumeration in which a #define resides. It not only stops the output, but before it does it mysteriously outputs the docs for the 3rd enumerated member a second time, then stops the enum docs even though several members remain to be documented in the enum. It does go on to generate the rest of the docs for the header file, just not for that enum. Including doxyfile congigurations, sample header, and screenshot of output.
Created attachment 202880 [details] Header file
Created attachment 202881 [details] Screenshot of output
#defines inside an enum are not supported. Not sure this is useful. What would you expect doxygen to do? skip over the #defines? Note that stopping a @name section half-way an enum is also not supported.
Yes, I would expect doxygen to skip the #defines and at least output the enum. Curious, why would this not be supported if C supports it? Our engineers say they do this because it works. The #defines tie in specifically with each specific enum, which is an ‘operation’ or ‘attribute’. Stopping a @name section half-way an enum worked in the past without problems. (was using 1.5.8 previously)
Hi Gail, I agree that doxygen should skip over the defines, and processes the enum values correctly. What doxygen will not do is put the #define in the same group or in the same documentation section as the enum values. Like in C, by the time the compiler parses the enum, the #define are already removed by the preprocessor. Stopping a @name half-way an enum is unsupported behaviour, so I would advice you not to depend on it.
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.0. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant.