Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class AtclauseOrderCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class AtclauseOrderCheck
extends AbstractJavadocCheck

    Checks the order of javadoc block-tags or javadoc tags.

    Note: Google used the term "at-clauses" for block tags in their guide till 2017-02-28.

    • 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.
    • Property target - Specify the list of targets to check at-clauses. Type is java.lang.String[]. Validation type is tokenTypesSet. Default value is CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF.
    • Property tagOrder - Specify the order by tags. Type is java.lang.String[]. Default value is @author, @deprecated, @exception, @param, @return, @see, @serial, @serialData, @serialField, @since, @throws, @version.

    To configure the default check: 

     <module name="AtclauseOrder">
   <property name="tagOrder" value="@author, @version, @param,
   @return, @throws, @exception, @see, @since, @serial,
   @serialField, @serialData, @deprecated"/>
   <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
   METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
 </module>

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • at.clause.order
    • javadoc.missed.html.close
    • javadoc.parse.rule.error
    • javadoc.wrong.singleton.html.tag
    Since:
    6.0

    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AtclauseOrderCheck

        public AtclauseOrderCheck()

    • Method Detail

      • setTarget

        public void setTarget​(java.lang.String... targets)
        Setter to specify the list of targets to check at-clauses.
        Parameters:
        targets - user's targets.

      • setTagOrder

        public void setTagOrder​(java.lang.String... orders)
        Setter to specify the order by tags.
        Parameters:
        orders - user's orders.