Class JavadocTagContinuationIndentationCheck

All Implemented Interfaces:
Configurable, Contextualizable

public class JavadocTagContinuationIndentationCheck extends AbstractJavadocCheck

Checks the indentation of the continuation lines in at-clauses. 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.

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

To configure the default check:

 <module name="JavadocTagContinuationIndentation"/>
 

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="JavadocTagContinuationIndentation">
   <property name="offset" value="2"/>
 </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="JavadocTagContinuationIndentation">
   <property name="violateExecutionOnNonTightHtml" value="true"/>
 </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 {
 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • javadoc.missed.html.close
  • javadoc.parse.rule.error
  • javadoc.wrong.singleton.html.tag
  • tag.continuation.indent
Since:
6.0
  • Field Details

    • MSG_KEY

      public static final String MSG_KEY
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
  • Constructor Details

    • JavadocTagContinuationIndentationCheck

      public JavadocTagContinuationIndentationCheck()
  • Method Details