Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocMissingLeadingAsteriskCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class JavadocMissingLeadingAsteriskCheck
extends AbstractJavadocCheck

    Checks if the javadoc has leading asterisks on each line.

    The check does not require asterisks on the first line, nor on the last line if it is blank. All other lines in a Javadoc should start with *, including blank lines and code blocks.

    • 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.

    To configure the check: 

     <module name="JavadocMissingLeadingAsterisk"/>

    Example: 

     /**
  * Valid Java-style comment.
  *
  * <pre>
  *   int value = 0;
  * </pre>
  */
 class JavaStyle {} // ok

 /** Valid Scala-style comment.
   * Some description here.
   **/
 class ScalaStyle {} // ok

 /** **
  * Asterisks on first and last lines are optional.
  * */
 class Asterisks {} // ok

 /** No asterisks are required for single-line comments. */
 class SingleLine {} // ok

 /** // violation on next blank line, javadoc has lines without leading asterisk.

  */
 class BlankLine {}

 /** Wrapped
     single-line comment */ // violation, javadoc has lines without leading asterisk.
 class Wrapped {}

 /**
  * <pre>
     int value; // violation, javadoc has lines without leading asterisk.
  * </pre>
  */
 class Code {}

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • javadoc.missed.html.close
    • javadoc.missing.asterisk
    • javadoc.parse.rule.error
    • javadoc.wrong.singleton.html.tag
    Since:
    8.38