Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class InappropriateJavadocBlockTagsOnPackageCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

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.InappropriateJavadocBlockTagsOnPackageCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class InappropriateJavadocBlockTagsOnPackageCheck
extends AbstractJavadocCheck

Checks that Javadoc block tags for package definitions do not contain tags that are semantically invalid for packages.

Package definitions do not have return types or throw declarations. Therefore, @return and @throws/@exception Javadoc block tags used in their Javadoc comments are considered inappropriate and should be removed or replaced with proper documentation.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.inappropriate.tag

Since:

14.1.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private DetailAST	currentAst	Java AST node whose attached Javadoc is currently being processed.
static final String	MSG_INAPPROPRIATE_TAG	A key is pointing to the warning message text in "messages.properties" file.
static final String	PACKAGE	The package keyword for logging.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

MSG_JAVADOC_PARSE_RULE_ERROR, MSG_KEY_UNCLOSED_HTML_TAG

Constructor Summary

Constructors

Constructor	Description
InappropriateJavadocBlockTagsOnPackageCheck()	Creates a new InappropriateJavadocBlockTagsOnPackageCheck instance.

Method Summary

Modifier and Type	Method	Description
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
private static String	getTagName(DetailNode ast)	Returns the tag name corresponding to the given Javadoc token type.
void	visitJavadocToken(DetailNode ast)	Called to process a Javadoc token.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, getAcceptableJavadocTokens, getBlockCommentAst, init, isCommentNodesRequired, leaveJavadocToken, log, setJavadocTokens, setViolateExecutionOnNonTightHtml

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

clearViolations, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MSG_INAPPROPRIATE_TAG

public static final String MSG_INAPPROPRIATE_TAG

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

PACKAGE

public static final String PACKAGE

The package keyword for logging.

See Also:

• Constant Field Values

currentAst

private DetailAST currentAst

Java AST node whose attached Javadoc is currently being processed.

Constructor Details

InappropriateJavadocBlockTagsOnPackageCheck

public InappropriateJavadocBlockTagsOnPackageCheck()

Creates a new InappropriateJavadocBlockTagsOnPackageCheck instance.

Method Details

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Overrides:

getDefaultTokens in class AbstractJavadocCheck

Returns:

the default tokens

See Also:

• TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class AbstractJavadocCheck

Returns:

the token set this must be registered for.

See Also:

• TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Overrides:

getAcceptableTokens in class AbstractJavadocCheck

Returns:

the token set this check is designed for.

See Also:

• TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractJavadocCheck

Parameters:

ast - the token to process

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:

• JavadocCommentsTokenTypes

getRequiredJavadocTokens

public int[] getRequiredJavadocTokens()

Description copied from class: AbstractJavadocCheck

The javadoc tokens that this check must be registered for.

Overrides:

getRequiredJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this must be registered for.

See Also:

• JavadocCommentsTokenTypes

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

getTagName

private static String getTagName(DetailNode ast)

Returns the tag name corresponding to the given Javadoc token type.

Parameters:

ast - the Javadoc token

Returns:

the tag name as a string

Throws:

IllegalArgumentException - if the token type is not recognized as a Javadoc block tag that is inappropriate for package definitions.