After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 665629 - Enum docs cease after #define inside enum
Enum docs cease after #define inside enum
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.7.6
Other Windows
: Normal major
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2011-12-05 22:25 UTC by Gail
Modified: 2012-02-25 15:37 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Configuration file (73.71 KB, text/plain)
2011-12-05 22:25 UTC, Gail
Details
Header file (1.90 KB, text/plain)
2011-12-05 22:26 UTC, Gail
Details
Screenshot of output (27.34 KB, image/png)
2011-12-05 22:27 UTC, Gail
Details

Description Gail 2011-12-05 22:25:56 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.
Comment 1 Gail 2011-12-05 22:26:55 UTC
Created attachment 202880 [details]
Header file
Comment 2 Gail 2011-12-05 22:27:37 UTC
Created attachment 202881 [details]
Screenshot of output
Comment 3 Dimitri van Heesch 2011-12-10 10:58:06 UTC
#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.
Comment 4 Gail 2011-12-12 15:44:37 UTC
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)
Comment 5 Dimitri van Heesch 2012-02-05 14:20:56 UTC
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.
Comment 6 Dimitri van Heesch 2012-02-25 15:37:29 UTC
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.