From efb815802131562433127c3f034bc10acf9af8ff Mon Sep 17 00:00:00 2001
From: Roman Ivanov <ivanov-jr@mail.ru>
Date: Sat, 27 Jun 2015 20:47:40 -0700
Subject: [PATCH] checkstyle_checks.xml was extended to catch TODO and FIXME,
 javadoc/xdoc also updated to have more useful example

---
 config/checkstyle_checks.xml                                | 4 +++-
 config/suppressions.xml                                     | 2 ++
 .../tools/checkstyle/checks/TodoCommentCheck.java           | 6 +++---
 src/xdocs/config_misc.xml                                   | 4 ++--
 4 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/config/checkstyle_checks.xml b/config/checkstyle_checks.xml
index 1d84d9ec7..f19473933 100644
--- a/config/checkstyle_checks.xml
+++ b/config/checkstyle_checks.xml
@@ -258,7 +258,9 @@
     <module name="ThrowsCount">
       <property name="max" value="2"/>
     </module>
-    <module name="TodoComment"/>
+    <module name="TodoComment">
+      <property name="format" value="(TODO)|(FIXME)" />
+    </module>
     <module name="UncommentedMain"/>
     <module name="UnnecessaryParentheses"/>
     <module name="AbbreviationAsWordInName"/>
diff --git a/config/suppressions.xml b/config/suppressions.xml
index 878fde813..3b58c7b29 100644
--- a/config/suppressions.xml
+++ b/config/suppressions.xml
@@ -12,6 +12,8 @@
     <suppress checks="AbbreviationAsWordInName"
               files="JavaNCSSCheck.java"
               lines="40"/>
+    <!-- illegal words are part of Javadoc -->
+    <suppress checks="TodoComment" files=".*TodoCommentCheck\.java"/>
 
     <!-- Tone down the checking for test code -->
     <suppress checks="EmptyBlock" files=".*[\\/]src[\\/]test[\\/]"/>
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java
index 0f1d2e76c..e4cb0cf49 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java
@@ -28,7 +28,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 
 /**
  * <p>
- * A check for 'TODO' comments. To check for other patterns in Java comments, set
+ * A check for 'TODO:' comments. To check for other patterns in Java comments, set
  * property format.
  * </p>
  * <p>
@@ -40,12 +40,12 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
  * </pre>
  * <p>
  * An example of how to configure the check for comments that contain
- * <code>WARNING</code> is:
+ * <code>TODO</code> or <code>FIXME</code>is:
  * </p>
  *
  * <pre>
  * &lt;module name="TodoComment"&gt;
- *    &lt;property name="format" value="WARNING"/&gt;
+ *    &lt;property name="format" value="(TODO)|(FIXME)"/&gt;
  * &lt;/module&gt;
  * </pre>
  * @author Oliver Burn
diff --git a/src/xdocs/config_misc.xml b/src/xdocs/config_misc.xml
index bab5240c8..1eb316866 100755
--- a/src/xdocs/config_misc.xml
+++ b/src/xdocs/config_misc.xml
@@ -154,11 +154,11 @@
         </source>
 
         <p>
-          To configure the check for comments that contain <code>WARNING</code>:
+          To configure the check for comments that contain <code>TODO</code> and <code>FIXME</code>:
         </p>
         <source>
 &lt;module name=&quot;TodoComment&quot;&gt;
-    &lt;property name=&quot;format&quot; value=&quot;WARNING&quot;/&gt;
+    &lt;property name=&quot;format&quot; value=&quot;(TODO)|(FIXME)&quot;/&gt;
 &lt;/module&gt;
         </source>
       </subsection>