Class JavadocParagraphCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class JavadocParagraphCheck
    extends AbstractJavadocCheck
    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.

    The check can be specified by option allowNewlineParagraph, which says whether the <p> tag should be placed immediately before the first word.

    Default configuration:

     <module name="JavadocParagraph"/>
     

    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:

       /**
        * <p>
        * Some Javadoc.
        *
        * <p>  Some Javadoc.
        *
        * <p>
        * <pre>
        * Some preformatted Javadoc.
        * </pre>
        *
        */
     
    • Field Detail

      • MSG_TAG_AFTER

        public static final 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 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 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 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()