RequireEmptyLineBeforeBlockTagGroup

Since Checkstyle 8.36

Description

Checks that one blank line before the block tag if it is present in Javadoc.

Properties

name description type default value since
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.36

Examples

To configure the check: 

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

The check will report a violation if there is no blank line before the block tag, like in the example below. 

class Example1 {
  /**
   * ValidMethod's javadoc.
   *
   * @return something
   */
  boolean methodWithValidJavadoc() {
    return false;
  }
  /**
   * InvalidMethod's javadoc.
   * @return something
   */ // violation above, ''@return' should be preceded with an empty line'
  boolean methodWithInvalidJavadoc() {
    return false;
  }
}

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