Description

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.

Properties

Examples

To configure the default check:

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocParagraph"/>
  </module>
</module>
        

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

// violation 5 lines below '<p> tag should be preceded with an empty line'
/**
 * 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).
 *
 */
// violation 3 lines above 'tag should be placed immediately before the first word'
public class Example1 {
}
        

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

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

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

// violation 5 lines below '<p> tag should be preceded with an empty line'
/**
 * No tag (ok).
 *
 * <p>Tag immediately before the text (ok).
 * <p>No blank line before the tag.
 *
 * <p>
 * New line after tag (ok).
 *
 * <p> Whitespace after tag (ok).
 *
 */
// violation 6 lines above 'tag should be placed immediately before the first word'
// violation 4 lines above 'tag should be placed immediately before the first word'
public class Example2 {
}
        

Example of Usage

• Google Style
• Checkstyle Style

Violation Messages

• 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.unclosedHtml
• javadoc.wrong.singleton.html.tag

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks.javadoc

Parent Module

TreeWalker