com.puppycrawl.tools.checkstyle.checks.javadoc
public class JavadocMethodCheck extends AbstractTypeAwareCheck
Version: 1.1
Method Summary | |
---|---|
int[] | getAcceptableTokens() {@inheritDoc} |
int[] | getDefaultTokens() {@inheritDoc} |
protected boolean | isMissingJavadocAllowed(DetailAST aAST)
The JavadocMethodCheck is about to report a missing Javadoc.
|
protected void | logLoadError(Token aIdent)
Logs error if unable to load class information.
|
protected void | processAST(DetailAST aAST)
Checks Javadoc comments for a method or constructor.
|
void | setAllowMissingJavadoc(boolean aFlag)
Controls whether to ignore errors when there is no javadoc. |
void | setAllowMissingParamTags(boolean aFlag)
controls whether to allow a method which has parameters to omit matching
param tags in the javadoc. |
void | setAllowMissingPropertyJavadoc(boolean aFlag)
Controls whether to ignore errors when there is no javadoc for a
property accessor (setter/getter methods). |
void | setAllowMissingReturnTag(boolean aFlag)
controls whether to allow a method which returns non-void type to omit
the return tag in the javadoc. |
void | setAllowMissingThrowsTags(boolean aFlag)
controls whether to allow a method which declares that it throws
exceptions to omit matching throws tags in the javadoc. |
void | setAllowThrowsTagsForSubclasses(boolean aFlag)
controls whether to allow documented exception that are subclass of one
of declared exceptions.
|
void | setAllowUndeclaredRTE(boolean aFlag)
controls whether to allow documented exceptions that are not declared if
they are a subclass of java.lang.RuntimeException.
|
void | setExcludeScope(String aScope)
Set the excludeScope.
|
void | setScope(String aFrom)
Set the scope.
|
allowMissingJavadoc
and
allowMissingPropertyJavadoc
properties, do not forget
to call super.isMissingJavadocAllowed(aAST)
in case
you want to keep this logic.Parameters: aAST the tree node for the method or constructor.
Returns: True if this method or constructor doesn't need Javadoc.
Parameters: aIdent class name for which we can no load class.
Parameters: aAST the tree node for the method or constructor.
Parameters: aFlag a Boolean
value
Parameters: aFlag a Boolean
value
Parameters: aFlag a Boolean
value
Parameters: aFlag a Boolean
value
Parameters: aFlag a Boolean
value
Parameters: aFlag a Boolean
value
Parameters: aFlag a Boolean
value
Parameters: aScope a String
value
Parameters: aFrom a String
value