Class JavadocTypeCheck
- 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.JavadocTypeCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class JavadocTypeCheck extends AbstractCheck
Checks the Javadoc of a type.Does not perform checks for author and version tags for inner classes, as they should be redundant because of outer class.
-
-
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 String
MSG_JAVADOC_MISSING
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_MISSING_TAG
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_TAG_FORMAT
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_UNKNOWN_TAG
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_UNUSED_TAG
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_UNUSED_TAG_GENERAL
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description JavadocTypeCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods 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
setAllowMissingParamTags(boolean flag)
Controls whether to allow a type which has type parameters to omit matching param tags in the javadoc.void
setAllowUnknownTags(boolean flag)
Controls whether to flag errors for unknown tags.void
setAuthorFormat(Pattern pattern)
Set the author tag pattern.void
setExcludeScope(Scope excludeScope)
Set the excludeScope.void
setScope(Scope scope)
Sets the scope to check.void
setVersionFormat(Pattern pattern)
Set the version format pattern.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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 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
-
MSG_UNKNOWN_TAG
public static final String MSG_UNKNOWN_TAG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_TAG_FORMAT
public static final String MSG_TAG_FORMAT
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_MISSING_TAG
public static final String MSG_MISSING_TAG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_UNUSED_TAG
public static final String MSG_UNUSED_TAG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_UNUSED_TAG_GENERAL
public static final String MSG_UNUSED_TAG_GENERAL
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
setScope
public void setScope(Scope scope)
Sets the scope to check.- Parameters:
scope
- a scope.
-
setExcludeScope
public void setExcludeScope(Scope excludeScope)
Set the excludeScope.- Parameters:
excludeScope
- a scope.
-
setAuthorFormat
public void setAuthorFormat(Pattern pattern)
Set the author tag pattern.- Parameters:
pattern
- a pattern.
-
setVersionFormat
public void setVersionFormat(Pattern pattern)
Set the version format pattern.- Parameters:
pattern
- a pattern.
-
setAllowMissingParamTags
public void setAllowMissingParamTags(boolean flag)
Controls whether to allow a type which has type parameters to omit matching param tags in the javadoc. Defaults to false.- Parameters:
flag
- aBoolean
value
-
setAllowUnknownTags
public void setAllowUnknownTags(boolean flag)
Controls whether to flag errors for unknown tags. Defaults to false.- Parameters:
flag
- aBoolean
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:
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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- Parameters:
ast
- the token to process
-
-