Class JavadocParagraphCheck

Checks the Javadoc paragraph.

Checks that:

• There is one blank line between each of two paragraphs.
• Each paragraph but the first has <p> immediately before the first word, with no space after.

• Property violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. Type is boolean. Default value is false.
• Property allowNewlineParagraph - Control whether the <p> tag should be placed immediately before the first word. Type is boolean. Default value is true.

To configure the default check:

 <module name="JavadocParagraph"/>
 

By default, the check will report a violation if there is a new line or whitespace after the <p> tag:

 /**
  * No tag (ok).
  *
  * <p>Tag immediately before the text (ok).
  * <p>No blank line before the tag (violation).
  *
  * <p>
  * New line after tag (violation).
  *
  * <p> Whitespace after tag (violation).
  *
  */
 public class TestClass {
 }
 

To allow newlines and spaces immediately after the <p> tag:

 <module name="JavadocParagraph">
   <property name="allowNewlineParagraph" value="false"/>
 </module>
 

In case of allowNewlineParagraph set to false the following example will not have any violations:

 /**
  * No tag (ok).
  *
  * <p>Tag immediately before the text (ok).
  * <p>No blank line before the tag (violation).
  *
  * <p>
  * New line after tag (ok).
  *
  * <p> Whitespace after tag (ok).
  *
  */
 public class TestClass {
 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.missed.html.close
• javadoc.paragraph.line.before
• javadoc.paragraph.misplaced.tag
• javadoc.paragraph.redundant.paragraph
• javadoc.paragraph.tag.after
• javadoc.parse.rule.error
• javadoc.wrong.singleton.html.tag