[Doxygen-users] Complaint regarding the quality of HTML code output

[<hes...@he...>]

I have bean using using Doxygen for documenting the API of the Quad-Ren
graphics engine. Because I want the documentation to blend seamlessly with
the rest of the website I have bean tacking parts of the generated HTML
and adding that to the projects website. Which was when I noticed just how
bad the code Doxygen produces actually is, take the following extract for
example:

<div class="memitem">
<div class="memproto">
------<table class="memname">
--------<tr>
----------<td class="memname">int qr_scene_node::get_frame-----------</td>
----------<td>(</td>
----------<td class="paramname">----------</td>
----------<td>&nbsp;)&nbsp;</td>
----------<td><code> [inline]</code></td>
--------</tr>
------</table>
</div>
<div class="memdoc">

<p>
Gets the animation frame.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current animation
frame number. </dd></dl>

</div>
</div>



The following is how I would rewrite it:

<div class="memitem">
----<div class="memproto">
--------<table>
------------<tr>
----------------<td class="memname">int qr_scene_node::get_frame</td>
----------------<td>(</td>
----------------<td class="paramname"></td>
----------------<td>&nbsp;)&nbsp;</td>
----------------<td class="memstatic">[inline]</td>
------------</tr>
--------</table>
----</div>
----<div class="memdoc">
--------<h4>Description:</h4>
--------<p>Gets the animation frame.</p>

--------<h4>Returns:</h4>
--------<p>Current animation frame number.</p>
----</div>
</div>

The primary differences are:
----In the Doxygen output, <p> is closed with <p> not </p> as it should be.
----My indenting is a lot easier to read.
----My code replaces all in-line formatting with CSS.
----The returns line is marked up as a heading and a paragraph, so is
easer to read.
----The Doxygen code contains a number of useless gaps.
----My code is valid XHTML 1.0, Doxygens output is not.

I look forward to seeing these errors fixed, and possibly an easer way of
embedding Doxygen output into existing websites, as re writing the Doxygen
code takes a significant amount of time.

If you wish to see how the result looks, see:
http://quad-ren.sourceforge.net/index.php?section=API%20Documentation&page=qr_math