Skip to content

Files

Latest commit

 

History

History
54 lines (36 loc) · 998 Bytes

JavadocParagraph.md

File metadata and controls

54 lines (36 loc) · 998 Bytes

Pattern: Malformed Javadoc paragraph

Issue: -

Description

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

    immediately before the first word, with no space after.

Examples

Default configuration:

<module name="JavadocParagraph"/>

To allows to place text of a paragraph not immediately after a

tag:

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

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

/**
 * Some Javadoc.
 *
 * <p>
 * Some Javadoc.
 *
 * <p>  Some Javadoc.
 *
 * <p>
 * <pre>
 * Some preformatted Javadoc.
 * </pre>
 *
 */

Further Reading