commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Simon Kitching <skitch...@apache.org>
Subject Re: Javadoc formatting style
Date Mon, 07 Feb 2005 02:06:49 GMT
On Sun, 2005-02-06 at 17:18 -0800, Craig McClanahan wrote:
> As should be evident from my own recent practice :-), I'm also +1 on
> the first (XHTML) approach.

Can I ask those supporters of the XHTML style why they prefer it?

Personally I think it:
* increases the text size of the source file
* is harder to write manually (and harder to write correctly)
* makes the docs in the source file harder to read
* might be easier for the javadoc app to parse, but that
  makes no difference to us users of javadoc; the javadoc
  tool support for HTML-style isn't going away.
and
* has no effect whatsoever on the generated html pages


Not that it's a *huge* deal, but HTML-style just seems a bit better all
around. Yet quite a few people obviously do prefer XHTML-style. Is it
just for the "purity"?


Regards,

Simon


---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message