From 93a8bb4f13cc5249a3e8f1c36c6ad0e44ad8ba21 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@apache.org>
Date: Wed, 21 May 2008 12:58:15 +0000
Subject: [PATCH] Configured checkstyle to stop complaining about incomplete
 Javadoc in some very specific cases.

This problem has been discussed previously here:
  http://markmail.org/message/pmbiyiqssjesq7tm

The solution implemented with this modification is to configure checkstyle
in such a way the errors can be filtered out using dedicated comments in the
source code:

  // CHECKSTYLE: stop JavadocMethodCheck

  // a bunch of functions known to trigger warnings
  // that we explicitly REFUSE to fix

  // CHECKSTYLE: resume JavadocMethodCheck

The checks are still performed normally in file parts not bracketed by
these comments. Hence the first few methods in o.a.c.m.stat.inference.TestUtils are
still checked for correct javadoc, and only for the last ones in the same files
are the checks relaxed.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/branches/MATH_2_0@658671 13f79535-47bb-0310-9956-ffa450edef68
---
 checkstyle.xml                                       | 12 ++++++++++++
 .../commons/math/stat/inference/TestUtils.java       |  4 ++++
 2 files changed, 16 insertions(+)

diff --git a/checkstyle.xml b/checkstyle.xml
index 0ce824731..4c39a7f94 100644
--- a/checkstyle.xml
+++ b/checkstyle.xml
@@ -67,9 +67,21 @@
 	<module name="IllegalInstantiation">
       <property name="classes" value="java.lang.Boolean, java.lang.String"/>
     </module>
+
+    <!-- Required for SuppressionCommentFilter below -->
+    <module name="FileContentsHolder"/>
+
   </module>
   
   <!-- Require package javadoc -->
   <module name="PackageHtml"/>
+
+  <!-- Setup special comments to suppress specific checks from source files -->
+  <module name="SuppressionCommentFilter">
+    <property name="offCommentFormat" value="CHECKSTYLE\: stop JavadocMethodCheck"/>
+    <property name="onCommentFormat"  value="CHECKSTYLE\: resume JavadocMethodCheck"/>
+    <property name="checkFormat"      value="JavadocMethodCheck"/>
+  </module>
+
 </module>
 
diff --git a/src/java/org/apache/commons/math/stat/inference/TestUtils.java b/src/java/org/apache/commons/math/stat/inference/TestUtils.java
index e5178095f..d311efb10 100644
--- a/src/java/org/apache/commons/math/stat/inference/TestUtils.java
+++ b/src/java/org/apache/commons/math/stat/inference/TestUtils.java
@@ -128,6 +128,8 @@ public class TestUtils  {
     }
     
     
+    // CHECKSTYLE: stop JavadocMethodCheck
+
     /**
      * @see org.apache.commons.math.stat.inference.TTest#homoscedasticT(double[], double[])
      */
@@ -407,4 +409,6 @@ public class TestUtils  {
         return oneWayAnova.anovaTest(categoryData, alpha);
     }
 
+    // CHECKSTYLE: resume JavadocMethodCheck
+
 }