Improve documentation of getSupportedCheckers() (typetools#6924)

mernst · Dec 17, 2024 · 1c8b2ab · 1c8b2ab
1 parent 4d8fedb
commit 1c8b2ab
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/framework/src/main/java/org/checkerframework/framework/source/AggregateChecker.java b/framework/src/main/java/org/checkerframework/framework/source/AggregateChecker.java
@@ -31,12 +31,11 @@ public abstract class AggregateChecker extends SourceChecker {
   protected AggregateChecker() {}
 
   /**
-   * Returns the list of independent subcheckers to be run together. Subclasses need to override
-   * this method.
+   * Returns the list of independent subcheckers to be run together. An aggregate checker overrides
+   * this method to indicate its immediate subcheckers.
    *
-   * @return the list of checkers to be run
+   * @return the list of immediate subcheckers checkers to be run
    */
-  // These are immediate subcheckers.
   protected abstract Collection<Class<? extends SourceChecker>> getSupportedCheckers();
 
   @Override