[commons-rng] branch master updated: Require method javadoc for private scope

[aherbert]

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git


The following commit(s) were added to refs/heads/master by this push:
     new f7981ca9 Require method javadoc for private scope
f7981ca9 is described below

commit f7981ca959a8ded9b7f2305e400590a4fb4361b2
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Sun Jun 26 22:41:27 2022 +0100

    Require method javadoc for private scope
---
 src/main/resources/checkstyle/checkstyle-suppressions.xml | 3 +++
 src/main/resources/checkstyle/checkstyle.xml              | 8 ++++++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/src/main/resources/checkstyle/checkstyle-suppressions.xml 
b/src/main/resources/checkstyle/checkstyle-suppressions.xml
index d4bea176..7317f671 100644
--- a/src/main/resources/checkstyle/checkstyle-suppressions.xml
+++ b/src/main/resources/checkstyle/checkstyle-suppressions.xml
@@ -36,4 +36,7 @@
   <suppress checks="MethodLength" 
files="ProbabilityDensityApproximationCommand" />
   <suppress checks="FileLength" files="[\\/]StableSamplerTest" />
   <suppress checks="FileLength" files="[\\/]ZigguratSamplerPerformance" />
+  <!-- Suppress checks for the method-local inner classes -->
+  <suppress checks="MissingJavadocType" files="[\\/]LXMBenchmark" />
+  <suppress checks="MissingJavadocMethod" files="[\\/]LXMBenchmark" />
 </suppressions>
diff --git a/src/main/resources/checkstyle/checkstyle.xml 
b/src/main/resources/checkstyle/checkstyle.xml
index 4450a8fb..b3bf596b 100644
--- a/src/main/resources/checkstyle/checkstyle.xml
+++ b/src/main/resources/checkstyle/checkstyle.xml
@@ -92,9 +92,13 @@
     <module name="JavadocType" />
     <module name="JavadocVariable" />
     <module name="JavadocStyle" />
-    <module name="MissingJavadocMethod" />
+    <module name="MissingJavadocMethod">
+      <property name="scope" value="private"/>
+    </module>
     <module name="MissingJavadocPackage" />
-    <module name="MissingJavadocType" />
+    <module name="MissingJavadocType">
+      <property name="scope" value="private"/>
+    </module>
 
     <!-- Checks for Naming Conventions. -->
     <!-- See http://checkstyle.sourceforge.net/config_naming.html -->