API documentation - Please don't use illegal HTML in comments like "L&F"

[Hannes Wallnoefer]

Chris Burdess wrote:

> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Mark Wielaard wrote:
>
>> Please avoid using illegal HTML in comments.
>> gjdoc currently doesn't handle that very well.
>>
>> Obviously we should fix gjdoc (or actually libxmlj it seems) but in the
>> meantime please avoid using non-XHTML in comments.
>
>
> Regarding "fixing" libxmlj: I've considered adding HTML parsing 
> support with implementations for the HTML DOM, however there is 
> absolutely no facility in JAXP as far as I can see to declare that an 
> input source is intended to be HTML (or anything other than XML). I 
> haven't seen support for parsing HTML in any other JAXP parser either.


You might want to have a look at Tagsoup. This is a SAX parser written 
for real-world HTML that will swallow and tag-balance almost anything 
you throw at it. Last time I looked at it it worked really well.

http://mercury.ccil.org/~cowan/XML/tagsoup/

Hannes

> I am happy to add additional functionality to GnomeDocumentBuilder if 
> nobody has any more generic solution. However, in the short term it 
> may be more sensible to use an HTML parser for gjdoc - I can recommend 
> John Cowan's TagSoup:
>
>     http://mercury.ccil.org/~cowan/XML/tagsoup/
> - -- Chris Burdess
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.2.4 (Darwin)
>
> iD8DBQFA7adb6dl1DEqHgrgRAgYgAKCDrH1Mdg9S+C1dsaKZ8EluJlKG4wCglxBZ
> yaxYL5PqpjHETQ/uHiJFsFA=
> =9L6D
> -----END PGP SIGNATURE-----
>