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 and one blank line before the at-clauses block if it is present.
    • 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. Default value is false.
    • Property allowNewlineParagraph - Control whether the <p> tag should be placed immediately before the first word. 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 {
     }
     
    Since:
    6.0
    • Field Detail

      • MSG_TAG_AFTER

        public static final java.lang.String MSG_TAG_AFTER
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
      • MSG_LINE_BEFORE

        public static final java.lang.String MSG_LINE_BEFORE
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
      • MSG_REDUNDANT_PARAGRAPH

        public static final java.lang.String MSG_REDUNDANT_PARAGRAPH
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
      • MSG_MISPLACED_TAG

        public static final java.lang.String MSG_MISPLACED_TAG
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
    • Constructor Detail

      • JavadocParagraphCheck

        public JavadocParagraphCheck()