com.puppycrawl.tools.checkstyle.meta.checks.javadoc.JavadocMissingLeadingAsteriskCheck.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation
Show all versions of checkstyle Show documentation
Checkstyle is a development tool to help programmers write Java code
that adheres to a coding standard
<?xml version="1.0" encoding="UTF-8"?> <checkstyle-metadata> <module> <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck" name="JavadocMissingLeadingAsterisk" parent="com.puppycrawl.tools.checkstyle.TreeWalker"> <description><p> Checks if the javadoc has <a href="https://docs.oracle.com/en/java/javase/14/docs/specs/javadoc/doc-comment-spec.html#leading-asterisks"> leading asterisks</a> on each line. </p> <p> 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 {@code *}, including blank lines and code blocks. </p></description> <properties> <property default-value="false" name="violateExecutionOnNonTightHtml" type="boolean"> <description>Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at <a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules">Tight-HTML Rules</a>.</description> </property> </properties> <message-keys> <message-key key="javadoc.missed.html.close"/> <message-key key="javadoc.missing.asterisk"/> <message-key key="javadoc.parse.rule.error"/> <message-key key="javadoc.wrong.singleton.html.tag"/> </message-keys> </check> </module> </checkstyle-metadata>