Class MissingJavadocMethodCheck
- 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.MissingJavadocMethodCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class MissingJavadocMethodCheck extends AbstractCheck
Checks for missing Javadoc comments for a method or constructor. The scope to verify is specified using the
Scope
class and defaults toScope.PUBLIC
. To verify another scope, set property scope to a different scope.Javadoc is not required on a method that is tagged with the
@Override
annotation. However under Java 5 it is not possible to mark a method required for an interface (this was corrected under Java 6). Hence Checkstyle supports using the convention of using a single{@inheritDoc}
tag instead of all the other tags.For getters and setters for the property
allowMissingPropertyJavadoc
, the methods must match exactly the structures below.public void setNumber(final int number) { mNumber = number; } public int getNumber() { return mNumber; } public boolean isSomething() { return false; }
-
Property
minLineCount
- Control the minimal amount of lines in method to allow no documentation. Default value is-1
. -
Property
allowedAnnotations
- Configure the list of annotations that allow missed documentation. Default value isOverride
. -
Property
scope
- Specify the visibility scope where Javadoc comments are checked. Default value ispublic
. -
Property
excludeScope
- Specify the visibility scope where Javadoc comments are not checked. Default value isnull
. -
Property
allowMissingPropertyJavadoc
- Control whether to allow missing Javadoc on accessor methods for properties (setters and getters). Default value isfalse
. -
Property
ignoreMethodNamesRegex
- ignore method whose names are matching specified regex. Default value isnull
. -
Property
tokens
- tokens to check Default value is: METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF.
To configure the default check:
<module name="MissingJavadocMethod"/>
To configure the check for
private
scope:<module name="MissingJavadocMethod"> <property name="scope" value="private"/> </module>
To configure the check for methods which are in
private
, but not inprotected
scope:<module name="MissingJavadocMethod"> <property name="scope" value="private"/> <property name="excludeScope" value="protected"/> </module>
To configure the check for ignoring methods named
foo(),foo1(),foo2()
, etc.:<module name="MissingJavadocMethod"> <property name="ignoreMethodNamesRegex" value="^foo.*$"/> </module>
- Since:
- 8.21
-
-
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 java.lang.String
MSG_JAVADOC_MISSING
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description MissingJavadocMethodCheck()
-
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
setAllowedAnnotations(java.lang.String... userAnnotations)
Setter to configure the list of annotations that allow missed documentation.void
setAllowMissingPropertyJavadoc(boolean flag)
Setter to control whether to allow missing Javadoc on accessor methods for properties (setters and getters).void
setExcludeScope(Scope excludeScope)
Setter to specify the visibility scope where Javadoc comments are not checked.void
setIgnoreMethodNamesRegex(java.util.regex.Pattern pattern)
Setter to ignore method whose names are matching specified regex.void
setMinLineCount(int value)
Setter to control the minimal amount of lines in method to allow no documentation.void
setScope(Scope scope)
Setter to specify the visibility scope where Javadoc comments are checked.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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 Detail
-
MSG_JAVADOC_MISSING
public static final java.lang.String MSG_JAVADOC_MISSING
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
setAllowedAnnotations
public void setAllowedAnnotations(java.lang.String... userAnnotations)
Setter to configure the list of annotations that allow missed documentation.- Parameters:
userAnnotations
- user's value.
-
setIgnoreMethodNamesRegex
public void setIgnoreMethodNamesRegex(java.util.regex.Pattern pattern)
Setter to ignore method whose names are matching specified regex.- Parameters:
pattern
- a pattern.
-
setMinLineCount
public void setMinLineCount(int value)
Setter to control the minimal amount of lines in method to allow no documentation.- Parameters:
value
- user's value.
-
setAllowMissingPropertyJavadoc
public void setAllowMissingPropertyJavadoc(boolean flag)
Setter to control whether to allow missing Javadoc on accessor methods for properties (setters and getters).- Parameters:
flag
- aBoolean
value
-
setScope
public void setScope(Scope scope)
Setter to specify the visibility scope where Javadoc comments are checked.- Parameters:
scope
- a scope.
-
setExcludeScope
public void setExcludeScope(Scope excludeScope)
Setter to specify the visibility scope where Javadoc comments are not checked.- Parameters:
excludeScope
- a scope.
-
getRequiredTokens
public final 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
-
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
-
visitToken
public final void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
-