NonEmptyAtclauseDescriptionCheck (checkstyle 8.36.1 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.AbstractCheck
    - - com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
      - com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck

All Implemented Interfaces:

Configurable, Contextualizable
```
public class NonEmptyAtclauseDescriptionCheck
extends AbstractJavadocCheck
```
Checks that the at-clause tag is followed by description.
- 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 javadocTokens - javadoc tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is PARAM_LITERAL, RETURN_LITERAL, THROWS_LITERAL, EXCEPTION_LITERAL, DEPRECATED_LITERAL.
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

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  AutomaticBean.OutputStreamOptions

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
- Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
  MSG_JAVADOC_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG

Constructor Summary

Constructors
Constructor Description

NonEmptyAtclauseDescriptionCheck()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int[]`	`getDefaultJavadocTokens()`	Returns the default javadoc token types a check is interested in.
`void`	`visitJavadocToken(DetailNode ast)`	Called to process a Javadoc token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredJavadocTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearMessages, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MSG_KEY
```
public static final java.lang.String MSG_KEY
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NonEmptyAtclauseDescriptionCheck
```
public NonEmptyAtclauseDescriptionCheck()
```
- Method Detail
  - getDefaultJavadocTokens
```
public int[] getDefaultJavadocTokens()
```
    Description copied from class: AbstractJavadocCheck
    
    Returns the default javadoc token types a check is interested in.
    
    Specified by:
    
    getDefaultJavadocTokens in class AbstractJavadocCheck
    
    Returns:
    
    the default javadoc token types
    
    See Also:
    
    JavadocTokenTypes
  - visitJavadocToken
```
public void visitJavadocToken(DetailNode ast)
```
    Description copied from class: AbstractJavadocCheck
    
    Called to process a Javadoc token.
    
    Specified by:
    
    visitJavadocToken in class AbstractJavadocCheck
    
    Parameters:
    
    ast - the token to process