Issue checkstyle#13007: Update doc for UnusedImports

TanayMorakhia · Apr 30, 2023 · 7058a25 · 7058a25
1 parent 15f8367
commit 7058a25
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 49 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheck.java
@@ -41,8 +41,7 @@
 
 /**
  * <p>
- * Checks for unused import statements. Checkstyle uses a simple but very
- * reliable algorithm to report on unused import statements. An import statement
+ * Checks for unused import statements. An import statement
  * is considered unused if:
  * </p>
  * <ul>
@@ -78,20 +77,6 @@
  * There are two or more static imports with the same method name.
  * </li>
  * </ul>
- * <p>
- * For example, in the following case all imports will not be flagged as unused:
- * </p>
- * <pre>
- * import java.awt.Component;
- * import static AstTreeStringPrinter.printFileAst;
- * import static DetailNodeTreeStringPrinter.printFileAst;
- * class FooBar {
- *   private Object Component; // a bad practice in my opinion
- *   void method() {
- *       printFileAst(file); // two imports with the same name
- *   }
- * }
- * </pre>
  * <ul>
  * <li>
  * Property {@code processJavadoc} - Control whether to process Javadoc comments.
@@ -107,6 +92,12 @@
  * </pre>
  * <p>Example:</p>
  * <pre>
+ * import java.awt.Component; // limitation as it match field name in code
+ *
+ * // no ability to recognize what import is not used
+ * import static AstTreeStringPrinter.printFileAst;
+ * import static DetailNodeTreeStringPrinter.printFileAst;
+ *
  * import java.lang.String; // violation
  *
  * import java.util.Stack;  // OK
@@ -119,6 +110,7 @@
  * &#42;&#47;
  * class MyClass{
  *   Stack stack = new Stack();
+ *   private Object Component;
  * }
  * </pre>
  * <p>
@@ -131,6 +123,12 @@
  * </pre>
  * <p>Example:</p>
  * <pre>
+ * import java.awt.Component; // limitation as it match field name in code
+ *
+ * // no ability to recognize what import is not used
+ * import static AstTreeStringPrinter.printFileAst;
+ * import static DetailNodeTreeStringPrinter.printFileAst;
+ *
  * import java.lang.String; // violation
  *
  * import java.util.Stack;  // OK
@@ -143,6 +141,7 @@
  * &#42;&#47;
  * class MyClass{
  *   Stack stack = new Stack();
+ *   private Object Component;
  * }
  * </pre>
  * <p>

diff --git a/...main/resources/com/puppycrawl/tools/checkstyle/meta/checks/imports/UnusedImportsCheck.xml b/...main/resources/com/puppycrawl/tools/checkstyle/meta/checks/imports/UnusedImportsCheck.xml
@@ -5,8 +5,7 @@
               name="UnusedImports"
               parent="com.puppycrawl.tools.checkstyle.TreeWalker">
          <description>&lt;p&gt;
- Checks for unused import statements. Checkstyle uses a simple but very
- reliable algorithm to report on unused import statements. An import statement
+ Checks for unused import statements. An import statement
  is considered unused if:
  &lt;/p&gt;
  &lt;ul&gt;
@@ -41,21 +40,7 @@
  &lt;li&gt;
  There are two or more static imports with the same method name.
  &lt;/li&gt;
- &lt;/ul&gt;
- &lt;p&gt;
- For example, in the following case all imports will not be flagged as unused:
- &lt;/p&gt;
- &lt;pre&gt;
- import java.awt.Component;
- import static AstTreeStringPrinter.printFileAst;
- import static DetailNodeTreeStringPrinter.printFileAst;
- class FooBar {
-   private Object Component; // a bad practice in my opinion
-   void method() {
-       printFileAst(file); // two imports with the same name
-   }
- }
- &lt;/pre&gt;</description>
+ &lt;/ul&gt;</description>
          <properties>
             <property default-value="true" name="processJavadoc" type="boolean">
                <description>Control whether to process Javadoc comments.</description>

diff --git a/src/xdocs/config_imports.xml b/src/xdocs/config_imports.xml
@@ -2454,8 +2454,7 @@ public class MyClass{ };
       <p>Since Checkstyle 3.0</p>
       <subsection name="Description" id="UnusedImports_Description">
         <p>
-          Checks for unused import statements. Checkstyle uses a simple but
-          very reliable algorithm to report on unused import statements. An
+          Checks for unused import statements. An
           import statement is considered unused if:
         </p>
 
@@ -2497,20 +2496,6 @@ public class MyClass{ };
             There are two or more static imports with the same method name.
           </li>
         </ul>
-        <p>
-          For example, in the following case all imports will not be flagged as unused:
-        </p>
-        <source>
-import java.awt.Component;
-import static AstTreeStringPrinter.printFileAst;
-import static DetailNodeTreeStringPrinter.printFileAst;
-class FooBar {
-  private Object Component; // a bad practice in my opinion
-  void method() {
-      printFileAst(file); // two imports with the same name
-  }
-}
-        </source>
       </subsection>
 
       <subsection name="Properties" id="UnusedImports_Properties">
@@ -2543,6 +2528,12 @@ class FooBar {
         </source>
         <p>Example:</p>
         <source>
+import java.awt.Component; // limitation as it match field name in code
+
+// no ability to recognize what import is not used
+import static AstTreeStringPrinter.printFileAst;
+import static DetailNodeTreeStringPrinter.printFileAst;
+
 import java.lang.String; // violation
 
 import java.util.Stack;  // OK
@@ -2555,6 +2546,7 @@ import java.util.List; // OK
 &#42;&#47;
 class MyClass{
     Stack stack = new Stack();
+    private Object Component;
 }
         </source>
         <p>
@@ -2567,6 +2559,11 @@ class MyClass{
         </source>
         <p>Example:</p>
         <source>
+import java.awt.Component; // limitation as it match field name in code
+
+// no ability to recognize what import is not used
+import static AstTreeStringPrinter.printFileAst;
+import static DetailNodeTreeStringPrinter.printFileAst;
 import java.lang.String; // violation
 
 import java.util.Stack;  // OK
@@ -2579,6 +2576,7 @@ import java.util.List; // violation
 &#42;&#47;
 class MyClass{
     Stack stack = new Stack();
+    private Object Component;
 }
         </source>
       </subsection>