On Sun, 6 Feb 2005 19:46:30 -0500, Henri Yandell <[EMAIL PROTECTED]> wrote: > However, the point of javadoc is to put it in HTML, and using the > latest version of HTML (ie XHTML) seems like the thing to do. > > Otherwise we could just ignore the <p>'s all together and make it look > even better for source reading. > > +1 to the first :)
I am also +1 on the first (XHTML) option. -- Martin Cooper > Hen > > On Mon, 7 Feb 2005 00:03:15 -0000, Stephen Colebourne > <[EMAIL PROTECTED]> wrote: > > [lang] uses the first. [collections] uses the second. > > > > I prefer the second as IMHO it is more readable when you are browsing the > > source code. And I definitely read the javadoc in source code form more than > > I read it in html form. > > > > Stephen > > > > ----- Original Message ----- > > From: "Simon Kitching" <[EMAIL PROTECTED]> > > > I have seen two basic approaches to applying formatting to javadoc text > > > in source files: > > > > > > (a) XHTML-style > > > /** > > > *<p>This is the first paragraph.</p> > > > * > > > *<p>And this is the second.</p> > > > */ > > > > > > (b) HTML-style > > > /** > > > * This is the first paragraph. > > > * <p> > > > * And this is the second. > > > */ > > > > > > I would certainly like to pick one or the other for Digester2. What > > > conventions have other commons projects adopted? Are there any good > > > reasons to pick one over the other? > > > > > > Thanks, > > > > > > Simon > > > > > > > > > > > > --------------------------------------------------------------------- > > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
