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 709226 - Struct member fields not documented with INLINE_SIMPLE_STRUCTS
Struct member fields not documented with INLINE_SIMPLE_STRUCTS
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.5
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-10-01 19:30 UTC by Matteo Cypriani
Modified: 2016-11-12 18:40 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Minimal input file (300 bytes, text/x-chdr)
2013-10-01 19:30 UTC, Matteo Cypriani
Details
Minimal Doxyfile (542 bytes, application/octet-stream)
2013-10-01 19:30 UTC, Matteo Cypriani
Details
Updated minimal input file (430 bytes, text/x-chdr)
2013-10-11 20:37 UTC, Matteo Cypriani
Details

Description Matteo Cypriani 2013-10-01 19:30:07 UTC
Created attachment 256210 [details]
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).
Comment 1 Matteo Cypriani 2013-10-01 19:30:53 UTC
Created attachment 256211 [details]
Minimal Doxyfile
Comment 2 Matteo Cypriani 2013-10-11 20:37:27 UTC
Created attachment 257056 [details]
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
Comment 3 Dimitri van Heesch 2013-10-13 08:58:01 UTC
Confirmed. Should be fixed in the next GIT update.
Comment 4 Dimitri van Heesch 2013-12-24 18:59:43 UTC
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).
Comment 5 Matteo Cypriani 2014-02-11 17:33:43 UTC
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.
Comment 6 Dimitri van Heesch 2016-11-12 18:40:54 UTC
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.