Issue #7688: update doc for RedundantImport

checkstyle · Dec 17, 2021 · de4cb77 · de4cb77
1 parent c9134ce
commit de4cb77
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java
@@ -48,6 +48,20 @@
  * &lt;module name="RedundantImport"/&gt;
  * </pre>
  * <p>
+ * Example:
+ * </p>
+ * <pre>
+ * package Test;
+ * import static Test.MyClass.*; // OK, static import
+ * import static java.lang.Integer.MAX_VALUE; // OK, static import
+ *
+ * import Test.MyClass; // violation, imported from the same package as the current package
+ * import java.lang.String; // violation, the class imported is from the 'java.lang' package
+ * import java.util.Scanner; // OK
+ * import java.util.Scanner; // violation, it is a duplicate of another import
+ * public class MyClass{ };
+ * </pre>
+ * <p>
  * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
  * </p>
  * <p>

diff --git a/src/xdocs/config_imports.xml b/src/xdocs/config_imports.xml
@@ -2359,6 +2359,20 @@ public class SomeClass { }
         <source>
 &lt;module name=&quot;RedundantImport&quot;/&gt;
         </source>
+        <p>
+            Example:
+        </p>
+        <source>
+package Test;
+import static Test.MyClass.*; // OK, static import
+import static java.lang.Integer.MAX_VALUE; // OK, static import
+
+import Test.MyClass; // violation, imported from the same package as the current package
+import java.lang.String; // violation, the class imported is from the 'java.lang' package
+import java.util.Scanner; // OK
+import java.util.Scanner; // violation, it is a duplicate of another import
+public class MyClass{ };
+        </source>
       </subsection>
 
       <subsection name="Example of Usage" id="RedundantImport_Example_of_Usage">