com.puppycrawl.tools.checkstyle.meta.checks.javadoc.AtclauseOrderCheck.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.AtclauseOrderCheck"
             name="AtclauseOrder"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;p&gt;
 Checks the order of
 &lt;a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF"&gt;
 javadoc block-tags or javadoc tags&lt;/a&gt;.
 &lt;/p&gt;
 &lt;p&gt;
 Note: Google used the term "at-clauses" for block tags in their guide till 2017-02-28.
 &lt;/p&gt;</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
 &lt;a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules"&gt;Tight-HTML Rules&lt;/a&gt;.</description>
            </property>
            <property default-value="CLASS_DEF,INTERFACE_DEF,ENUM_DEF,METHOD_DEF,CTOR_DEF,VARIABLE_DEF,RECORD_DEF,COMPACT_CTOR_DEF"
                      name="target"
                      type="java.lang.String[]"
                      validation-type="tokenTypesSet">
               <description>Specify the list of block tags targeted.</description>
            </property>
            <property default-value="@author, @deprecated, @exception, @param, @return, @see, @serial, @serialData, @serialField, @since, @throws, @version"
                      name="tagOrder"
                      type="java.lang.String[]">
               <description>Specify the order by tags.</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="at.clause.order"/>
            <message-key key="javadoc.missed.html.close"/>
            <message-key key="javadoc.parse.rule.error"/>
            <message-key key="javadoc.wrong.singleton.html.tag"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>