public class JavadocStyleCheck extends Check
Constructor and Description |
---|
JavadocStyleCheck() |
Modifier and Type | Method and Description |
---|---|
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.
|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- 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.Copyright © 2001-2015. All Rights Reserved.