commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stephen Colebourne <scolebou...@btopenworld.com>
Subject Re: old style html in javadoc Was: [jira] Commented: (IO-86) Add FileFinder back into Commons IO
Date Mon, 24 Jul 2006 23:55:09 GMT
Simon Kitching wrote:
> I'm with Stephen here; simple is good. Javadoc isn't expected to be
> processed by anything other than the javadoc tool, and that handles <p>
> as a separator fine, so why clutter things with </p>?

Just to clarify my POV - if I was writing a web page inmy day job, I 
would use XHTML. There are many good reasons for that, including the 
possibility to validate XHTML along the way and parse moe quickly in the 
browser.

However, as Simon points out, Javadoc isn't the same. Its just a tool 
for programmers, and the simple separator approach is cleaner (IMO) 
while having exactly the same result within the javadoc.

> Javadoc isn't really html. It's a java-specific doc format (like perl
> POD etc) that happens to resemble html. There are many markup formats
> that use the "separator" approach rather than the "container" approach. 
> 
> In practice, I think that either is bearable, so new files should follow
> whatever convention the project already has.

Yeh. I have to live with containers in lang, but io and collections use 
separator :-)

Stephen

---------------------------------------------------------------------
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