Description

Properties

Examples

To configure the default check that will check @param, @deprecated,@throws,@return:

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

Example1:

class Example1 {

  /**
   * Some summary.
   *
   * @param a Some description
   * @param b
   * @deprecated
   * @throws Exception
   * @return
   */
  public void testMethod(){
    // violation 6 lines above 'At-clause should have a non-empty description'
    // violation 6 lines above 'At-clause should have a non-empty description'
    // violation 6 lines above 'At-clause should have a non-empty description'
    // violation 6 lines above 'At-clause should have a non-empty description'
  }
}
        

To configure the check to validate @param, @throws tags:

<module name="Checker">
  <module name="TreeWalker">
    <module name="NonEmptyAtclauseDescription">
      <property name="javadocTokens" value="PARAM_LITERAL,THROWS_LITERAL"/>
    </module>
  </module>
</module>
        

Example2:

class Example2 {

  /**
   * Some summary.
   *
   * @param a Some description
   * @param b
   * @deprecated
   * @throws Exception
   * @return
   */
  public void testMethod(){
    // violation 6 lines above 'At-clause should have a non-empty description'
    // @deprecated ignored as not mentioned in javadocTokens
    // violation 6 lines above 'At-clause should have a non-empty description'
    // @return ignored as not mentioned in javadocTokens
  }
}
        

Example of Usage

• Google Style
• Checkstyle Style

Violation Messages

• javadoc.missed.html.close
• javadoc.parse.rule.error
• javadoc.unclosedHtml
• javadoc.wrong.singleton.html.tag
• non.empty.atclause

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