Add a TODO at the top of FlutterDependencyInspection (#7859)

flutter · Dec 17, 2024 · 2de174b · 2de174b
1 parent db2f786
commit 2de174b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/flutter-idea/src/io/flutter/inspections/FlutterDependencyInspection.java b/flutter-idea/src/io/flutter/inspections/FlutterDependencyInspection.java
@@ -29,6 +29,12 @@
 import java.util.HashSet;
 import java.util.Set;
 
+/**
+ * This LocalInspectionTool provides the banner on the top of the editor that
+ * <p>
+ * TODO(jwren) resolve and document why this is a LocalInspectionTool instead of a EditorNotificationProvider, the UX to the end user seems
+ *  to be the same, and not require a PsiFile.
+ */
 public class FlutterDependencyInspection extends LocalInspectionTool {
   private final Set<String> myIgnoredPubspecPaths = new HashSet<>(); // remember for the current session only, do not serialize