Class JavadocParagraphCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class JavadocParagraphCheck
    extends AbstractJavadocCheck

    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 allowNewlineParagraph - Control whether the <p> tag should be placed immediately before the first word. Type is boolean. Default value is true.
    • 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.

    Parent is

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