Issue checkstyle#4987: fixed Javadoc for minLineCount property and xdocx

sergileon · Aug 29, 2017 · 9150d13 · 9150d13
1 parent bd18c20
commit 9150d13
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java
@@ -125,7 +125,7 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck {
     private static final Pattern MATCH_JAVADOC_NOARG_CURLY =
             CommonUtils.createPattern("\\{\\s*@(inheritDoc)\\s*\\}");
 
-    /** Default value of minimal amount of lines in method to demand documentation presence.*/
+    /** Default value of minimal amount of lines in method to allow no documentation.*/
     private static final int DEFAULT_MIN_LINE_COUNT = -1;
 
     /** The visibility scope where Javadoc comments are checked. */
@@ -134,7 +134,7 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck {
     /** The visibility scope where Javadoc comments shouldn't be checked. */
     private Scope excludeScope;
 
-    /** Minimal amount of lines in method to demand documentation presence.*/
+    /** Minimal amount of lines in method to allow no documentation.*/
     private int minLineCount = DEFAULT_MIN_LINE_COUNT;
 
     /**
@@ -202,7 +202,7 @@ public void setIgnoreMethodNamesRegex(Pattern pattern) {
     }
 
     /**
-     * Sets minimal amount of lines in method.
+     * Sets minimal amount of lines in method to allow no documentation.
      * @param value user's value.
      */
     public void setMinLineCount(int value) {

diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml
@@ -212,7 +212,7 @@ public int checkReturnTag(final int aTagIndex,
           </tr>
           <tr>
             <td>minLineCount</td>
-            <td>Minimal amount of lines in method to demand documentation presence.</td>
+            <td>Minimal amount of lines in method to allow no documentation.</td>
             <td><a href="property_types.html#integer">Integer</a></td>
             <td><code>-1</code></td>
             <td>6.0</td>