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.
scope - specify the visibility scope where Javadoc comments are checked.
Type is com.puppycrawl.tools.checkstyle.api.Scope.
Default value is public.
excludeScope - specify the visibility scope where Javadoc comments are not
checked.
Type is com.puppycrawl.tools.checkstyle.api.Scope.
Default value is null.
skipAnnotations - specify the list of annotations that allow missed
documentation. Only short names are allowed, e.g. Generated.
Type is java.lang.String[].
Default value is Generated.
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.
To configure the default check to make sure all public class, enum, interface, and annotation interface, definitions have javadocs:
<module name="MissingJavadocType"/>
Example:
public class PublicClass {} // violation
private class PublicClass {}
protected class PublicClass {}
class PackagePrivateClass {}
To configure the check for private scope:
<module name="MissingJavadocType"> <property name="scope" value="private"/> </module>
Example:
public class PublicClass {} // violation
private class PublicClass {} // violation
protected class PublicClass {} // violation
class PackagePrivateClass {} // violation
To configure the check for private classes only:
<module name="MissingJavadocType"> <property name="scope" value="private"/> <property name="excludeScope" value="package"/> </module>
Example:
public class PublicClass {}
private class PublicClass {} // violation
protected class PublicClass {}
class PackagePrivateClass {}
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="MissingJavadocType"> <property name="skipAnnotations" value="SpringBootApplication,Configuration"/> </module>
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
javadoc.missing
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
MSG_JAVADOC_MISSING
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
MissingJavadocTypeCheck() |
| Modifier and Type | Method and 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(java.lang.String... userAnnotations)
Setter to specify the list of annotations that allow missed documentation.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final java.lang.String MSG_JAVADOC_MISSING
public MissingJavadocTypeCheck()
public void setScope(Scope scope)
scope - a scope.public void setExcludeScope(Scope excludeScope)
excludeScope - a scope.public void setSkipAnnotations(java.lang.String... userAnnotations)
Generated.userAnnotations - user's value.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processCopyright © 2001-2020. All Rights Reserved.