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

Dalibor Topic robilad@kaffe.org
Fri Jul 9 10:51:00 GMT 2004


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.

I think XHTML is fine, I believe Mark was just having trouble with gjdoc 
crashing because of occurences of 'L&F' in javadocs :)

cheers,
dalibor topic



More information about the Java mailing list