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 term "at-clauses" for block tags in his guide till 2017-02-28.

    The check allows to configure itself by using the following properties:

    • target - allows to specify targets to check at-clauses.
    • tagOrder - allows to specify the order by tags.

    Default configuration:

     <module name="AtclauseOrderCheck">
         <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>
     
    Author:
    max