Emmanuel Bernard edited a comment on Bug BVAL-322

Definitive rules by the Book Of Emmanuel are:

  • use [...] for omissions
  • remove email in @author
  • do not use <programlisting role="JAVA" language="JAVA> as we have not introduced the plumbing
  • use {@link} for method reference (the first in the JavaDoc of the element) except if it references external classes and if it references the class or element at bay.
  • reference methods with () but be careful that some methodname are actually annotation attributes and thus should not have ()
  • no import statement
  • add package statement
  • use <p/> to separate paragraphs but do not use <p>blah blah</p>
  • empty line between @doc elements of different types
  • something is true but a method returns <literal>true</literal>
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira