Class JavadocTypeCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks the Javadoc comments for type definitions. By default, does
not check for author or version tags. The scope to verify is specified using the Scope
class and defaults to Scope.PRIVATE
. To verify another scope, set property
scope to one of the Scope
constants. To define the format for an author
tag or a version tag, set property authorFormat or versionFormat respectively to a
pattern.
Does not perform checks for author and version tags for inner classes, as they should be redundant because of outer class.
Error messages about type parameters and record components for which no param tags are present
can be suppressed by defining property allowMissingParamTags
.
-
Property
scope
- Specify the visibility scope where Javadoc comments are checked. Type iscom.puppycrawl.tools.checkstyle.api.Scope
. Default value isprivate
. -
Property
excludeScope
- Specify the visibility scope where Javadoc comments are not checked. Type iscom.puppycrawl.tools.checkstyle.api.Scope
. Default value isnull
. -
Property
authorFormat
- Specify the pattern for@author
tag. Type isjava.util.regex.Pattern
. Default value isnull
. -
Property
versionFormat
- Specify the pattern for@version
tag. Type isjava.util.regex.Pattern
. Default value isnull
. -
Property
allowMissingParamTags
- Control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc. Type isboolean
. Default value isfalse
. -
Property
allowUnknownTags
- Control whether to ignore violations when a Javadoc tag is not recognised. Type isboolean
. Default value isfalse
. -
Property
allowedAnnotations
- Specify the list of annotations that allow missed documentation. Only short names are allowed, e.g.Generated
. Type isjava.lang.String[]
. Default value isGenerated
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: INTERFACE_DEF, CLASS_DEF, ENUM_DEF, ANNOTATION_DEF, RECORD_DEF.
To configure the default check:
<module name="JavadocType"/>
To configure the check for public
scope:
<module name="JavadocType"> <property name="scope" value="public"/> </module>
To configure the check for an @author
tag:
<module name="JavadocType"> <property name="authorFormat" value="\S"/> </module>
To configure the check for a CVS revision version tag:
<module name="JavadocType"> <property name="versionFormat" value="\$Revision.*\$"/> </module>
To configure the check for private
classes only:
<module name="JavadocType"> <property name="scope" value="private"/> <property name="excludeScope" value="package"/> </module>
Example that allows missing comments for classes annotated with
@SpringBootApplication
and @Configuration
:
@SpringBootApplication // no violations about missing comment on class public class Application {} @Configuration // no violations about missing comment on class class DatabaseConfiguration {}
Use following configuration:
<module name="JavadocType"> <property name="allowedAnnotations" value="SpringBootApplication,Configuration"/> </module>
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
javadoc.unknownTag
-
javadoc.unusedTag
-
javadoc.unusedTagGeneral
-
type.missingTag
-
type.tagFormat
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionSpecify the list of annotations that allow missed documentation.private boolean
Control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.private boolean
Control whether to ignore violations when a Javadoc tag is not recognised.private Pattern
Specify the pattern for@author
tag.private static final String
Close angle bracket literal.private Scope
Specify the visibility scope where Javadoc comments are not checked.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file.private static final String
Open angle bracket literal.private Scope
Specify the visibility scope where Javadoc comments are checked.private static final String
Space literal.private static final Pattern
Pattern to match type name within angle brackets in javadoc param tag.private static final Pattern
Pattern to split type name field in javadoc param tag.private Pattern
Specify the pattern for@version
tag. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
checkComponentParamTag
(DetailAST ast, List<JavadocTag> tags, String recordComponentName) Verifies that a record definition has the specified param tag for the specified record component name.private void
Verifies that a type definition has a required tag.private void
checkTypeParamTag
(DetailAST ast, List<JavadocTag> tags, String typeParamName) Verifies that a type definition has the specified param tag for the specified type parameter name.private void
checkUnusedParamTags
(List<JavadocTag> tags, List<String> typeParamNames, List<String> recordComponentNames) Checks for unused param tags for type parameters and record components.private static String
Extracts parameter name from tag.int[]
The configurable token set.int[]
Returns the default token a check is interested in.private List
<JavadocTag> getJavadocTags
(TextBlock textBlock) Gets all standalone tags from a given javadoc.Collects the record components in a record definition.int[]
The tokens that this check must be registered for.void
setAllowedAnnotations
(String... userAnnotations) Setter to specify the list of annotations that allow missed documentation.void
setAllowMissingParamTags
(boolean flag) Setter to control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.void
setAllowUnknownTags
(boolean flag) Setter to control whether to ignore violations when a Javadoc tag is not recognised.void
setAuthorFormat
(Pattern pattern) Setter to specify the pattern for@author
tag.void
setExcludeScope
(Scope excludeScope) Setter to specify the visibility scope where Javadoc comments are not checked.void
Setter to specify the visibility scope where Javadoc comments are checked.void
setVersionFormat
(Pattern pattern) Setter to specify the pattern for@version
tag.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, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_UNKNOWN_TAG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_TAG_FORMAT
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_MISSING_TAG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_UNUSED_TAG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_UNUSED_TAG_GENERAL
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
OPEN_ANGLE_BRACKET
Open angle bracket literal.- See Also:
-
CLOSE_ANGLE_BRACKET
Close angle bracket literal.- See Also:
-
SPACE
Space literal.- See Also:
-
TYPE_NAME_IN_JAVADOC_TAG
Pattern to match type name within angle brackets in javadoc param tag. -
TYPE_NAME_IN_JAVADOC_TAG_SPLITTER
Pattern to split type name field in javadoc param tag. -
scope
Specify the visibility scope where Javadoc comments are checked. -
excludeScope
Specify the visibility scope where Javadoc comments are not checked. -
authorFormat
Specify the pattern for@author
tag. -
versionFormat
Specify the pattern for@version
tag. -
allowMissingParamTags
private boolean allowMissingParamTagsControl whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc. -
allowUnknownTags
private boolean allowUnknownTagsControl whether to ignore violations when a Javadoc tag is not recognised. -
allowedAnnotations
Specify the list of annotations that allow missed documentation. Only short names are allowed, e.g.Generated
.
-
-
Constructor Details
-
JavadocTypeCheck
public JavadocTypeCheck()
-
-
Method Details
-
setScope
Setter to specify the visibility scope where Javadoc comments are checked.- Parameters:
scope
- a scope.
-
setExcludeScope
Setter to specify the visibility scope where Javadoc comments are not checked.- Parameters:
excludeScope
- a scope.
-
setAuthorFormat
Setter to specify the pattern for@author
tag.- Parameters:
pattern
- a pattern.
-
setVersionFormat
Setter to specify the pattern for@version
tag.- Parameters:
pattern
- a pattern.
-
setAllowMissingParamTags
public void setAllowMissingParamTags(boolean flag) Setter to control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.- Parameters:
flag
- aBoolean
value
-
setAllowUnknownTags
public void setAllowUnknownTags(boolean flag) Setter to control whether to ignore violations when a Javadoc tag is not recognised.- Parameters:
flag
- aBoolean
value
-
setAllowedAnnotations
Setter to specify the list of annotations that allow missed documentation. Only short names are allowed, e.g.Generated
.- Parameters:
userAnnotations
- user's value.
-
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 classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
shouldCheck
Whether we should check this node.- Parameters:
ast
- a given node.- Returns:
- whether we should check a given node.
-
getJavadocTags
Gets all standalone tags from a given javadoc.- Parameters:
textBlock
- the Javadoc comment to process.- Returns:
- all standalone tags from the given javadoc.
-
checkTag
Verifies that a type definition has a required tag.- Parameters:
ast
- the AST node for the type definition.tags
- tags from the Javadoc comment for the type definition.tagName
- the required tag name.formatPattern
- regexp for the tag value.
-
checkComponentParamTag
private void checkComponentParamTag(DetailAST ast, List<JavadocTag> tags, String recordComponentName) Verifies that a record definition has the specified param tag for the specified record component name.- Parameters:
ast
- the AST node for the record definition.tags
- tags from the Javadoc comment for the record definition.recordComponentName
- the name of the type parameter
-
checkTypeParamTag
Verifies that a type definition has the specified param tag for the specified type parameter name.- Parameters:
ast
- the AST node for the type definition.tags
- tags from the Javadoc comment for the type definition.typeParamName
- the name of the type parameter
-
checkUnusedParamTags
private void checkUnusedParamTags(List<JavadocTag> tags, List<String> typeParamNames, List<String> recordComponentNames) Checks for unused param tags for type parameters and record components.- Parameters:
tags
- tags from the Javadoc comment for the type definition.typeParamNames
- names of type parametersrecordComponentNames
- list of record component names in this definition
-
extractParamNameFromTag
Extracts parameter name from tag.- Parameters:
tag
- javadoc tag to extract parameter name- Returns:
- extracts type parameter name from tag
-
getRecordComponentNames
Collects the record components in a record definition.- Parameters:
node
- the possible record definition ast.- Returns:
- the list of record components in this record definition.
-