Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.puppycrawl.tools.checkstyle.checks

Class TodoCommentCheck

Implemented Interfaces:
Configurable, Contextualizable
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>
Version:
1.0
Author:
Oliver Burn

Constructor Summary

TodoCommentCheck()
Creates a new TodoCommentCheck instance.

Method Summary

void
beginTree(DetailAST aRootAST)
int[]
getDefaultTokens()

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

getFormat, getRegexp, setCompileFlags, setFormat

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

TodoCommentCheck

public TodoCommentCheck()
Creates a new TodoCommentCheck instance.

Method Details

beginTree

public void beginTree(DetailAST aRootAST)
Overrides:
beginTree in interface Check

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

Overview Package Class Use Tree Index Deprecated About
Back to the Checkstyle Home Page