|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
public class JavadocStyleCheck
Custom Checkstyle Check to validate Javadoc.
| Constructor Summary | |
|---|---|
JavadocStyleCheck()
|
|
| Method Summary | |
|---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
void |
setCheckEmptyJavadoc(boolean aFlag)
Sets the flag that determines if empty JavaDoc checking should be done. |
void |
setCheckFirstSentence(boolean aFlag)
Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation. |
void |
setCheckHtml(boolean aFlag)
Sets the flag that determines if HTML checking is to be performed. |
void |
setEndOfSentenceFormat(String aFormat)
Set the format for matching the end of a sentence. |
void |
setExcludeScope(String aScope)
Set the excludeScope. |
void |
setScope(String aFrom)
Sets the scope to check. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
|---|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
|---|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
|---|
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public JavadocStyleCheck()
| Method Detail |
|---|
public int[] getDefaultTokens()
Check
getDefaultTokens in class CheckTokenTypespublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to processpublic void setScope(String aFrom)
aFrom - string to get the scope frompublic void setExcludeScope(String aScope)
aScope - a String valuepublic void setEndOfSentenceFormat(String aFormat)
aFormat - format for matching the end of a sentence.public void setCheckFirstSentence(boolean aFlag)
aFlag - true if the first sentence is to be checkedpublic void setCheckHtml(boolean aFlag)
aFlag - true if HTML checking is to be performed.public void setCheckEmptyJavadoc(boolean aFlag)
aFlag - true if empty JavaDoc checking should be done.
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||