com.puppycrawl.tools.checkstyle.meta.checks.javadoc.InvalidJavadocPositionCheck.xml Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 10.18.1

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck"
             name="InvalidJavadocPosition"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;p&gt;
 Checks that Javadocs are located at the correct position. As specified at
 &lt;a href="https://docs.oracle.com/en/java/javase/11/docs/specs/doc-comment-spec.html"&gt;
 Documentation Comment Specification for the Standard Doclet&lt;/a&gt;, Javadocs are recognized
 only when placed immediately before module, package, class, interface,
 constructor, method, or field declarations. Any other position, like in the
 body of a method, will be ignored by the javadoc tool and is considered
 invalid by this check.
 &lt;/p&gt;</description>
         <message-keys>
            <message-key key="invalid.position"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>