public class TodoCommentCheck extends AbstractFormatCheck
A check for TODO comments.
Actually it is a generic regular expression
matcher on Java 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()
Creates a new
TodoCommentCheck instance. |
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
getFormat, getRegexp, setCompileFlags, setFormat
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public TodoCommentCheck()
TodoCommentCheck
instance.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
Copyright © 2001-2013. All Rights Reserved.