Class JavadocTagContinuationIndentationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class JavadocTagContinuationIndentationCheck
    extends AbstractJavadocCheck

    Checks the indentation of the continuation lines in at-clauses.

    • 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. Default value is false.
    • Property offset - Specify how many spaces to use for new indentation level. Default value is 4.

    To configure the default check:

     <module name="JavadocTagContinuationIndentation"/>
     

    To configure the check with two spaces indentation:

     <module name="JavadocTagContinuationIndentation">
       <property name="offset" value="2"/>
     </module>
     
    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

      • JavadocTagContinuationIndentationCheck

        public JavadocTagContinuationIndentationCheck()