public class JavadocStyleCheck extends Check
Modifier and Type | Field and Description |
---|---|
static String |
EMPTY
Message property key for the Unclosed HTML message.
|
static String |
EXTRA_HTML
Message property key for the Extra HTML message.
|
static String |
INCOMPLETE_TAG
Message property key for the Unclosed HTML message.
|
static String |
JAVADOC_MISSING
Message property key for the Unclosed HTML message.
|
static String |
NO_PERIOD
Message property key for the Unclosed HTML message.
|
static String |
UNCLOSED_HTML
Message property key for the Unclosed HTML message.
|
Constructor and Description |
---|
JavadocStyleCheck() |
Modifier and Type | Method and Description |
---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
setCheckEmptyJavadoc(boolean flag)
Sets the flag that determines if empty Javadoc checking should be done.
|
void |
setCheckFirstSentence(boolean flag)
Sets the flag that determines if the first sentence is checked for
proper end of sentence punctuation.
|
void |
setCheckHtml(boolean flag)
Sets the flag that determines if HTML checking is to be performed.
|
void |
setEndOfSentenceFormat(String format)
Set the format for matching the end of a sentence.
|
void |
setExcludeScope(String excludeScope)
Set the excludeScope.
|
void |
setScope(String from)
Sets the scope to check.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String JAVADOC_MISSING
public static final String EMPTY
public static final String NO_PERIOD
public static final String INCOMPLETE_TAG
public static final String UNCLOSED_HTML
public static final String EXTRA_HTML
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processpublic void setScope(String from)
from
- string to get the scope frompublic void setExcludeScope(String excludeScope)
excludeScope
- a String
valuepublic void setEndOfSentenceFormat(String format)
format
- format for matching the end of a sentence.public void setCheckFirstSentence(boolean flag)
flag
- true
if the first sentence is to be checkedpublic void setCheckHtml(boolean flag)
flag
- true
if HTML checking is to be performed.public void setCheckEmptyJavadoc(boolean flag)
flag
- true
if empty Javadoc checking should be done.Copyright © 2001–2015. All rights reserved.