com.puppycrawl.tools.checkstyle.checks.javadoc
Class JavadocTypeCheck
- Configurable, Contextualizable
public class JavadocTypeCheck
Checks the Javadoc of a type.
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
getId , getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setId , setSeverity |
setAllowMissingParamTags
public void setAllowMissingParamTags(boolean aFlag)
Controls whether to allow a type which has type parameters to
omit matching param tags in the javadoc. Defaults to false.
setAuthorFormat
public void setAuthorFormat(String aFormat)
throws ConversionException
Set the author tag pattern.
setExcludeScope
public void setExcludeScope(String aScope)
Set the excludeScope.
setScope
public void setScope(String aFrom)
Sets the scope to check.
aFrom
- string to set scope from
setVersionFormat
public void setVersionFormat(String aFormat)
throws ConversionException
Set the version format pattern.