[Doxygen-develop] Re: Doxygen bug reports and suggestions

[Dimitri v. H. <di...@st...>]

Hi Thorsten!

On Wed, Dec 04, 2002 at 03:40:43PM +0100, Thorsten Schleinzer wrote:
> since the mailing list does not seem to be very vivid
> I send you here a list of bugs and suggestions I
> Found over the last week while writing a generic
> Frontend parsing the 'doxygenerated' XML and
> Converting it to various formats.

I read your mails on the list but hadn't found the time to respond.

> I'm using the current release version (1.3.1 I think)

Probably 1.3-rc1

> 
> On Windows XP Pro.
> 
> Bugs:
> 
> 1)
> 
> @note creates a kind="bug" simplesect instead of a kind="note"

Yep, that's a typo in src/xmldocvisitor.cpp

> 
> 2)
> 
> The @example tag does not work as expected:
> 
> Using the following code does lead to doxygen generate no
> detailed description at all:
> 
> /**
>  * Some descry...
>  *
>  * @example MM3D/Exception.example.cs
> 
> while the following workaround is ok:
> 
> /**
>  * Some descry...
>  *
>  * @par Example
>  * @include MM3D/Exception.example.cs

I'll look into this

> Suggestions:
> 1)
> 
> Please convert all mandatory whitespaces in the XML
> Output to  
> 
> Because in the currently generated code there is a lot
> Of stuff like:
> 
> <highlight class="normal"> </highlight>
> 
> Although this single space is important for the
> Actual output, most commonly used XML-Parsers don't
> Parse it but tell the tag is empty so that you can't
> Reproduce it exactly.
> 
> So please implement a switch to make XML-Output
> Encode all (important) whitespaces.

Doesn't have to be a switch for me. This is very easy
to implement by changing the filtering in src/xmlgen.cpp: codify(),
but I'm not sure if I then also have to define the meaning
of &nbsp; somewhere since &xxx; are merely macro's as far as I understand
XML otherwise not all parser will accept it. An alternative would be
a <space/> tag.

> 2)
> please add a 'static' attribute to the xml
> output so that one can see if a compound
> is static just by this attribute (just as 'const', 'volatile',...)
> without the need to take the surrounding sectiondef
> into account.

Good point. Will do that.

> 3) 
> 
> And last but not least:
> 
> Don't change the XML output to much in future versions
> Since it would render my parser useless ;-)

I don't intend to make major changes, but until doxygen 2.0 I'm not
making promises.

Please keep reporting problems as you see then and feel free to help me 
with coding ;-)

Regards,
  Dimitri