com.puppycrawl.tools.checkstyle.meta.checks.javadoc.JavadocVariableCheck.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

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

The newest version!

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck"
             name="JavadocVariable"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;div&gt;
 Checks that a variable has a Javadoc comment. Ignores {@code serialVersionUID} fields.
 &lt;/div&gt;</description>
         <properties>
            <property name="excludeScope" type="com.puppycrawl.tools.checkstyle.api.Scope">
               <description>Specify the visibility scope where Javadoc
 comments are not checked.</description>
            </property>
            <property name="ignoreNamePattern" type="java.util.regex.Pattern">
               <description>Specify the regexp to define variable names to ignore.</description>
            </property>
            <property default-value="private"
                      name="scope"
                      type="com.puppycrawl.tools.checkstyle.api.Scope">
               <description>Specify the visibility scope where Javadoc comments are checked.</description>
            </property>
            <property default-value="ENUM_CONSTANT_DEF"
                      name="tokens"
                      type="java.lang.String[]"
                      validation-type="tokenSet">
               <description>tokens to check</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="javadoc.missing"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>