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.

    Parent is

    Violation Message Keys:

    • javadoc.missed.html.close
    • javadoc.missing.asterisk
    • javadoc.parse.rule.error
    • javadoc.unclosedHtml
    • javadoc.wrong.singleton.html.tag