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 712743 - INLINE_GROUPED_CLASSES, INLINE_SIMPLE_STRUCTS can break XML in tagfile
INLINE_GROUPED_CLASSES, INLINE_SIMPLE_STRUCTS can break XML in tagfile
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: build
1.8.5
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-11-20 13:53 UTC by mejohansen
Modified: 2014-12-25 16:03 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Example project with failure (23.06 KB, application/zip)
2013-11-20 13:53 UTC, mejohansen
Details
Another example that generates invalid tagfiles. (3.22 KB, application/x-zip-compressed)
2014-09-11 16:09 UTC, tb
Details

Description mejohansen 2013-11-20 13:53:33 UTC
Created attachment 260311 [details]
Example project with failure

The tagfile generated by Doxygen has broken XML if you document a struct in a module group and set either one of or both of the options INLINE_GROUPED_CLASSES and INLINE_SIMPLE_STRUCTS to YES.

It looks as though the <compound kind="struct"> elements are not output correctly -- information about their members seems to be missing and the closing tags are missing.

In the attached project, both options are set to YES, and this gives the following output:
...
  <compound kind="group">
    <name>some_group</name>
...
  <compound kind="struct">
    <name>struct1</name>
    <filename>group__some__group.html</filename>
    <anchor>structstruct1</anchor>
  <compound kind="struct">
    <name>struct2</name>
    <filename>group__some__group.html</filename>
    <anchor>structstruct2</anchor>
  <compound kind="struct">
    <name>struct3</name>
    <filename>group__some__group.html</filename>
    <anchor>structstruct3</anchor>
  <compound kind="struct">
    <name>struct4</name>
    <filename>group__some__group.html</filename>
    <anchor>structstruct4</anchor>
<!-- What kind does the following tag close? -->
  </compound>
  <compound kind="page">
    <name>index</name>
    <title></title>
    <filename>index</filename>
    <docanchor file="index" title="Introduction">intro</docanchor>
  </compound>
</tagfile>


For comparison, if both configs are set to NO, the XML for a struct looks like:
  <compound kind="struct">
    <name>struct2</name>
    <filename>structstruct2.html</filename>
    <member kind="variable">
      <type>int *</type>
      <name>member4</name>
      <anchorfile>structstruct2.html</anchorfile>
      <anchor>a572a6b2ef8ce6d8c5386d51a14784026</anchor>
      <arglist></arglist>
    </member>
    <member kind="variable">
      <type>char *</type>
      <name>member5</name>
      <anchorfile>structstruct2.html</anchorfile>
      <anchor>a84a4fcc0ce38c81894a5015cc7d5bd20</anchor>
      <arglist></arglist>
    </member>
  </compound>
Comment 1 tb 2014-09-11 16:03:57 UTC
Experiencing the same issue with Doxygen 1.8.8 under Win 7 Professional. I could verify the given example code with the same results (incorrect tagfile if either INLINE_SIMPLE_STRUCTS or INLINE_GROUPED_CLASSES or both are set). The problem also occurs for ungrouped structs (then thy are only affected by INLINE_SIMPE_STRUCTS=YES). I appended another example to illustrate this.
Comment 2 tb 2014-09-11 16:09:55 UTC
Created attachment 285934 [details]
Another example that generates invalid tagfiles.

'example.h' contains only a single struct that isn't grouped. When enabling INLINE_SIMPLE_STRUCTS, Doxygen generates an invalid tagfile. 'example2.h' triggers the same issue with either INLINE_SIMPLE_STRUCTS or INLINE_GROUPED_CLASSES or both.
Comment 3 Dimitri van Heesch 2014-09-22 22:00:24 UTC
Confirmed. Should be fixed by this commit:
https://github.com/doxygen/doxygen/commit/b9ad9a03cf4febeb2aa10ddca22c1c9296c5223b

Please let me know if you still see issues.
Comment 4 Dimitri van Heesch 2014-12-25 16:03:28 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.9. 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).