JavadocTagContinuationIndentation

Since Checkstyle 6.0

Description

Checks the indentation of the continuation lines in block tags. That is whether the continued description of at clauses should be indented or not. If the text is not properly indented it throws a violation. A continuation line is when the description starts/spans past the line with the tag. Default indentation required is at least 4, but this can be changed with the help of properties below.

Properties

name description type default value since
offset Specify how many spaces to use for new indentation level. int 4 6.0
violateExecutionOnNonTightHtml Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. boolean false 8.3

Examples

To configure the default check: 

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocTagContinuationIndentation"/>
  </module>
</module>

Example: 

/**
 * @tag comment
 *  Indentation spacing is 1. Line with violation
 *   Indentation spacing is 2. Line with violation
 *     Indentation spacing is 4. OK
 */
public class Test {
}

To configure the check with two spaces indentation: 

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocTagContinuationIndentation">
      <property name="offset" value="2"/>
    </module>
  </module>
</module>

Example: 

/**
 * @tag comment
 * Indentation spacing is 0. Line with violation
 *   Indentation spacing is 2. OK
 *  Indentation spacing is 1. Line with violation
 */
public class Test {
}

To configure the check to show violations for Tight-HTML Rules: 

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocTagContinuationIndentation">
      <property name="violateExecutionOnNonTightHtml" value="true"/>
    </module>
  </module>
</module>

Example: 

/**
 * <p> 'p' tag is unclosed. Line with violation, this html tag needs closing tag.
 * <p> 'p' tag is closed</p>. OK
 */
public class Test {
}

Example of Usage

Violation Messages

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks.javadoc

Parent Module

TreeWalker