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 block tags targeted. 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"/>
     

    Example:

     /**
     * Some javadoc. // OK
     *
     * @author Some javadoc. // OK
     * @version Some javadoc. // OK
     * @param Some javadoc. // OK
     * @return Some javadoc. // OK
     * @throws Some javadoc. // OK
     * @exception Some javadoc. // OK
     * @see Some javadoc. // OK
     * @since Some javadoc. // OK
     * @serial Some javadoc. // OK
     * @serialField // OK
     * @serialData // OK
     * @deprecated Some javadoc. // OK
     */
    
     class Valid implements Serializable
     {
     }
    
     /**
     * Some javadoc.
     *
     * @since Some javadoc. // OK
     * @version Some javadoc. // Violation - wrong order
     * @deprecated
     * @see Some javadoc. // Violation - wrong order
     * @author Some javadoc. // Violation - wrong order
     */
    
     class Invalid implements Serializable
     {
     }
     

    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