com.puppycrawl.tools.checkstyle.checks.javadoc
Class JavadocStyleCheck
- Configurable, Contextualizable
public class JavadocStyleCheck
Custom Checkstyle Check to validate Javadoc.
- Chris Stillwell
- Daniel Grenner
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 |
setCheckEmptyJavadoc
public void setCheckEmptyJavadoc(boolean aFlag)
Sets the flag that determines if empty JavaDoc checking should be done.
aFlag
- true
if empty JavaDoc checking should be done.
setCheckFirstSentence
public void setCheckFirstSentence(boolean aFlag)
Sets the flag that determines if the first sentence is checked for
proper end of sentence punctuation.
aFlag
- true
if the first sentence is to be checked
setCheckHtml
public void setCheckHtml(boolean aFlag)
Sets the flag that determines if HTML checking is to be performed.
aFlag
- true
if HTML checking is to be performed.
setExcludeScope
public void setExcludeScope(String aScope)
Set the excludeScope.
setScope
public void setScope(String aFrom)
Sets the scope to check.
aFrom
- string to get the scope from