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

Class MissingJavadocTypeCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class MissingJavadocTypeCheck
extends AbstractCheck

Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to one of the Scope constants.

• Property excludeScope - Specify the visibility scope where Javadoc comments are not checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is null.
• Property scope - Specify the visibility scope where Javadoc comments are checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is public.
• Property skipAnnotations - Specify annotations that allow missed documentation. If annotation is present in target sources in multiple forms of qualified name, all forms should be listed in this property. Type is java.lang.String[]. Default value is Generated.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: INTERFACE_DEF, CLASS_DEF, ENUM_DEF, ANNOTATION_DEF, RECORD_DEF.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.missing

Since:

8.20

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 Scope	excludeScope	Specify the visibility scope where Javadoc comments are not checked.
static String	MSG_JAVADOC_MISSING	A key is pointing to the warning message text in "messages.properties" file.
private Scope	scope	Specify the visibility scope where Javadoc comments are checked.
private Set<String>	skipAnnotations	Specify annotations that allow missed documentation.

Constructor Summary

Constructors

Constructor	Description
MissingJavadocTypeCheck()

Method Summary

Modifier and Type	Method	Description
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
void	setExcludeScope(Scope excludeScope)	Setter to specify the visibility scope where Javadoc comments are not checked.
void	setScope(Scope scope)	Setter to specify the visibility scope where Javadoc comments are checked.
void	setSkipAnnotations(String... userAnnotations)	Setter to specify annotations that allow missed documentation.
private boolean	shouldCheck(DetailAST ast)	Whether we should check this node.
void	visitToken(DetailAST ast)	Called to process a token.

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

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, 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 Detail

MSG_JAVADOC_MISSING

public static final String MSG_JAVADOC_MISSING

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

See Also:

Constant Field Values

scope

private Scope scope

Specify the visibility scope where Javadoc comments are checked.

excludeScope

private Scope excludeScope

Specify the visibility scope where Javadoc comments are not checked.

skipAnnotations

private Set<String> skipAnnotations

Specify annotations that allow missed documentation. If annotation is present in target sources in multiple forms of qualified name, all forms should be listed in this property.

Constructor Detail

MissingJavadocTypeCheck

public MissingJavadocTypeCheck()

Method Detail

setScope

public void setScope(Scope scope)

Setter to specify the visibility scope where Javadoc comments are checked.

Parameters:

scope - a scope.

Since:

8.20

setExcludeScope

public void setExcludeScope(Scope excludeScope)

Setter to specify the visibility scope where Javadoc comments are not checked.

Parameters:

excludeScope - a scope.

Since:

8.20

setSkipAnnotations

public void setSkipAnnotations(String... userAnnotations)

Setter to specify annotations that allow missed documentation. If annotation is present in target sources in multiple forms of qualified name, all forms should be listed in this property.

Parameters:

userAnnotations - user's value.

Since:

8.20

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.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

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.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

shouldCheck

private boolean shouldCheck(DetailAST ast)

Whether we should check this node.

Parameters:

ast - a given node.

Returns:

whether we should check a given node.