public class TodoCommentCheck extends Check
A check for TODO comments. To check for other patterns in Java comments, set property format.
An example of how to configure the check is:
<module name="TodoComment"/>
An example of how to configure the check for comments that contain
WARNING
is:
<module name="TodoComment"> <property name="format" value="WARNING"/> </module>
Constructor and Description |
---|
TodoCommentCheck() |
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
boolean |
isCommentNodesRequired() |
void |
setFormat(String format)
Setter for todo comment format.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, 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 TodoCommentCheck()
public boolean isCommentNodesRequired()
isCommentNodesRequired
in class Check
public void setFormat(String format)
format
- format of todo comment.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processCopyright © 2001–2015. All rights reserved.