NonEmptyAtclauseDescriptionCheck

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 . Default configuration that will check @param, @return, @throws, @deprecated to:
```
 <module name="NonEmptyAtclauseDescription"/>
 
```

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, MSG_KEY_PARSE_ERROR, MSG_KEY_UNRECOGNIZED_ANTLR_ERROR

Constructor Summary

Constructors
Constructor Description

NonEmptyAtclauseDescriptionCheck()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int[]`	`getDefaultJavadocTokens()`	Returns the default javadoc token types a check is interested in.
`private static boolean`	`isEmptyTag(DetailNode tagNode)`	Tests if at-clause tag is empty.
`void`	`visitJavadocToken(DetailNode ast)`	Called to process a Javadoc token.

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

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, 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
  - isEmptyTag
```
private static boolean isEmptyTag(DetailNode tagNode)
```
    Tests if at-clause tag is empty.
    
    Parameters:
    
    tagNode - at-clause tag.
    
    Returns:
    
    true, if at-clause tag is empty.