Hi, [resurrecting an old thread, since it seems we still have some affected javadocs in Oak]
On Wed, Apr 3, 2013 at 10:46 AM, Jukka Zitting <[email protected]> wrote: > A trivially minor, but long-standing annoyance of mine seems to be > creeping over from Jackrabbit to Oak: > > For some reason people are using "<p/>" as a paragraph break in > Javadoc comments. That's wrong on many levels. Javadoc comments are in > HTML, not XHTML, so the self-closing "<p/>" is strictly speaking > invalid. And even if they were in XHTML, "<p/>" would indicate a > separate, empty paragraph instead starting a new paragraph. I have no > idea where this convention comes from. > > So, if it's not too much to ask, use "<p>" instead of "<p/>" when > starting a new paragraph in javadoc. It'll make my inner perfectionist > feel better when browsing source code. Avoiding this anti-pattern will also prevent problems with Java 8, where the javadoc tool will by default refuse to accept such comments. See https://bugs.openjdk.java.net/browse/JDK-8020619. BR, Jukka Zitting
