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 640754 - Invalid XML generated when using <list type="table"> in source.
Invalid XML generated when using <list type="table"> in source.
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
unspecified
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2011-01-27 19:37 UTC by Ray Lefuel
Modified: 2012-11-18 11:13 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Zip contains source, Doxygen-generated XML docs, Doxygen configuration file. (25.76 KB, application/x-zip-compressed)
2011-01-27 19:37 UTC, Ray Lefuel
Details

Description Ray Lefuel 2011-01-27 19:37:41 UTC
Created attachment 179467 [details]
Zip contains source, Doxygen-generated XML docs, Doxygen configuration file.

I use the <list type="table"> tag in my code comments to create tables in my C# code.  When Doxygen generates XML docs, it erroneously inserts </bold> and <bold> tags for every field, which results in invalid XML.  You also get an error when you try to use xsltproc or Saxon9 to combine the files.

These are my source docs (Found in Sample.cs):

/**
  <summary>
   <para>This is a class.</para>
  </summary>
  <remarks>
   <para>Here is a sample table:</para>
   <list type="table">
    <listheader>
     <term>Name</term>
     <term>Description</term>
    </listheader>
    <item>
     <term>Row1</term>
     <term>Description1</term>
    </item>
    <item>
     <term>Row2</term>
     <term>Description2</term>
    </item>
    <item>
     <term>Row3</term>
     <term>Description3</term>
    </item>
    <item>
     <term>Row4</term>
     <term>Description4</term>
    </item>
   </list>
   <para>Here is more text.</para>
*/

This is the Doxygen-generated XML result with the strange </bold> and <bold> tags (Found in class_sample.xml):

<para>Here is a sample table:</para><para><table rows="5" cols="2"><row>
<entry thead="yes"><para>Name</bold> <bold></para></entry><entry thead="yes"><para>Description</bold>  </para></entry></row>
<row>
<entry thead="no"><para>Row1</bold> <bold></para></entry><entry thead="no"><para>Description1</bold>  </para></entry></row>
<row>
<entry thead="no"><para>Row2</bold> <bold></para></entry><entry thead="no"><para>Description2</bold>  </para></entry></row>
<row>
<entry thead="no"><para>Row3</bold> <bold></para></entry><entry thead="no"><para>Description3</bold>  </para></entry></row>
<row>
<entry thead="no"><para>Row4</bold> <bold></para></entry><entry thead="no"><para>Description4</bold>  </para></entry></row>
</table>

This is the error that Saxon9 reports when I try to combine files:

Error on line 84 column 32 of class_sample.xml:
  SXXP0003: Error reported by XML parser: The element type "para" must be terminated by the
  matching end-tag "</para>".
Recoverable error on line 11 of combine.xslt:
  FODC0002: org.xml.sax.SAXParseException: The element type "para" must be terminated by the
  matching end-tag "</para>".

Currently, I run a python script post-generation to strip all the </bold> and <bold> tags from table structures; this seems to be the only way I can combine the XML files successfully.

I've attached my Doxygen configuration settings and the other applicable files.
Comment 1 Dimitri van Heesch 2011-01-29 19:15:16 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 2 Dimitri van Heesch 2011-03-28 14:19:31 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.4. 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.