Class NonEmptyAtclauseDescriptionCheck

All Implemented Interfaces:
Configurable, Contextualizable

public class NonEmptyAtclauseDescriptionCheck extends AbstractJavadocCheck

Checks that the at-clause tag is followed by description.

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

 <module name="NonEmptyAtclauseDescription"/>
 

To configure the check to validate only @param and @return tags:

 <module name="NonEmptyAtclauseDescription">
   <property name="javadocTokens" value="PARAM_LITERAL,RETURN_LITERAL"/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • javadoc.missed.html.close
  • javadoc.parse.rule.error
  • javadoc.wrong.singleton.html.tag
  • non.empty.atclause
Since:
6.0