Issue #7655: Update doc for ParameterAssignment

checkstyle · Feb 26, 2021 · 60043f4 · 60043f4
1 parent bea36f9
commit 60043f4
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ParameterAssignmentCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ParameterAssignmentCheck.java
@@ -50,6 +50,29 @@
  * &lt;module name=&quot;ParameterAssignment&quot;/&gt;
  * </pre>
  * <p>
+ * Example:
+ * </p>
+ * <pre>
+ * class MyClass {
+ *   int methodOne(int parameter) {
+ *     if (parameter &lt;= 0 ) {
+ *       throw new IllegalArgumentException("A positive value is expected");
+ *     }
+ *     parameter -= 2;  // violation
+ *     return parameter;
+ *   }
+ *
+ *   int methodTwo(int parameter) {
+ *     if (parameter &lt;= 0 ) {
+ *       throw new IllegalArgumentException("A positive value is expected");
+ *     }
+ *     int local = parameter;
+ *     local -= 2;  // OK
+ *     return local;
+ *   }
+ * }
+ * </pre>
+ * <p>
  * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
  * </p>
  * <p>

diff --git a/src/xdocs/config_coding.xml b/src/xdocs/config_coding.xml
@@ -5836,6 +5836,29 @@ public class AnnotationLocationCheck extends AbstractCheck {
         <source>
 &lt;module name=&quot;ParameterAssignment&quot;/&gt;
         </source>
+        <p>
+          Example:
+        </p>
+        <source>
+class MyClass {
+  int methodOne(int parameter) {
+    if (parameter &lt;= 0 ) {
+      throw new IllegalArgumentException("A positive value is expected");
+    }
+    parameter -= 2;  // violation
+    return parameter;
+  }
+
+  int methodTwo(int parameter) {
+    if (parameter &lt;= 0 ) {
+      throw new IllegalArgumentException("A positive value is expected");
+    }
+    int local = parameter;
+    local -= 2;  // OK
+    return local;
+  }
+}
+        </source>
       </subsection>
 
       <subsection name="Example of Usage" id="ParameterAssignment_Example_of_Usage">