New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enum docs cease after #define inside enum (Origin: bugzilla #665629) #4492

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity major in component general for ---
Reported in version 1.7.6 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-12-05 22:25:56 +0000, Gail wrote:

Created attachment 202879
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.

On 2011-12-05 22:26:55 +0000, Gail wrote:

Created attachment 202880
Header file

On 2011-12-05 22:27:37 +0000, Gail wrote:

Created attachment 202881
Screenshot of output

On 2011-12-10 10:58:06 +0000, Dimitri van Heesch wrote:

#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.

On 2011-12-12 15:44:37 +0000, Gail wrote:

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)

On 2012-02-05 14:20:56 +0000, Dimitri van Heesch wrote:

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.

On 2012-02-25 15:37:29 +0000, Dimitri van Heesch wrote:

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.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment