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

Nested C structures/unions does not work with groups (Origin: bugzilla #727732) #5445

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 normal in component general for ---
Reported in version 1.8.6 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2014-04-07 09:27:10 +0000, Lars Munch wrote:

Created attachment 273693
Small group structure bug example

When using nested C structures/unions with groups the nested structure/union does not use the group it was declared in e.g. "DummyGroup" in the following.

Consider the following file (dummy.h):

/**

  • @file group bug example
  • SecondLevel_s is not placed in group DummyGroup
    */

/** @addtogroup DummyGroup Dummy group

  • @{
    */

/**

  • Nested structure bug example
    /
    struct FirstLevel_s {
    /
    *
    • Second level structure which is misplaced
      */
      struct SecondLevel_s {
      int a; //!< Variable a
      int b; //!< Variable b
      } second; //!< Second level structure
      };

/** @} */

In this example "struct SecondLevel_s" documentation is not placed in the "DummyGroup". A workaround is to add "@InGroup DummyGroup", but this seems wrong as the group is already specified.

On 2014-06-06 15:37:34 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2014-06-28 11:04:32 +0000, Lars Munch wrote:

Resolved, Thanks.

On 2015-01-13 09:50:26 +0000, Maksim S wrote:

Is there a way to switch this behavior off?

In 1.8.6 groups containing several complex classes were clean, but in 1.8.9 a lot of internal (nested) structures and enums are added to group making it hard to understand the bigger picture.

Maybe it could be controlled with an option?

On 2015-06-26 19:06:22 +0000, Dimitri van Heesch wrote:

I'll add the option GROUP_NESTED_COMPOUNDS for this (default will be off)

@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