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

Struct member fields not documented with INLINE_SIMPLE_STRUCTS (Origin: bugzilla #709226) #5303

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.5 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-10-01 19:30:07 +0000, Matteo Cypriani wrote:

Created attachment 256210
Minimal input file

Hello,

The structures are not fully documented when INLINE_SIMPLE_STRUCTS is
enabled. I'm attaching a simple test file (teststruct.h) and a minimal
Doxyfile that will generate a man page, LaTeX and HTML. In all cases,
the structure's members are not documented, whereas disabling
INLINE_SIMPLE_STRUCTS produces a dedicated page or section where the
fields appear.

This bug was already present at least in version 1.8.3 (tested with Fedora 18's package).

On 2013-10-01 19:30:53 +0000, Matteo Cypriani wrote:

Created attachment 256211
Minimal Doxyfile

On 2013-10-11 20:37:27 +0000, Matteo Cypriani wrote:

Created attachment 257056
Updated minimal input file

So after further investigation (please see the corresponding Debian bug [1]), it appears that this problem comes from the fact that only the long description is used and the brief description is ignored. The attached file (teststruct2.h) shows what really happens. Although this work-around is enough, IMO this behaviour should still be considered as a bug.

[1] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=725122

On 2013-10-13 08:58:01 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2013-12-24 18:59:43 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.6. 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 (preferrably in the form of a self-contained example).

On 2014-02-11 17:33:43 +0000, Matteo Cypriani wrote:

Thanks for looking into this. It now works as it should for teststruct2.h (i.e. when both brief and long descriptions are provided). Unfortunately, the fix is incomplete, as it doesn't work with the initial teststruct.h. After investigation, it seems that it doesn't work when all the fields have only brief descriptions, but works for all the fields if at least one of them have a long description.

Tested with Doxygen 1.8.6 on Debian sid.

On 2016-11-12 18:40:54 +0000, Dimitri van Heesch wrote:

I could reproduce this with 1.8.6 indeed, but not with any later version.

Please reopen this bug report if you still see this issue with the latest version of doxygen.

@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