Documentation in GenericAnnotatedTypeFactory (#6626)

typetools · May 28, 2024 · da5d29d · da5d29d
1 parent 3a2780d
commit da5d29d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/framework/src/main/java/org/checkerframework/framework/type/GenericAnnotatedTypeFactory.java b/framework/src/main/java/org/checkerframework/framework/type/GenericAnnotatedTypeFactory.java
@@ -268,6 +268,10 @@ public abstract class GenericAnnotatedTypeFactory<
   // Set in postInit only
   protected Store emptyStore;
 
+  /**
+   * {@code analysis.getResult()} is the result of the most recent analysis. Compare to {@link
+   * #flowResult}.
+   */
   // Set in postInit only
   protected FlowAnalysis analysis;
 
@@ -288,6 +292,8 @@ public abstract class GenericAnnotatedTypeFactory<
    * @see AnalysisResult#runAnalysisFor(Node, Analysis.BeforeOrAfter, TransferInput,
    *     IdentityHashMap, Map)
    */
+  // This is only used in `getStoreBefore()` and `getStoreAfter()`.
+  // We do not understand its relationship to the `analysisCaches` field of each result.
   protected final Map<
           TransferInput<Value, Store>, IdentityHashMap<Node, TransferResult<Value, Store>>>
       flowResultAnalysisCaches;
@@ -1077,7 +1083,7 @@ protected enum ScanState {
   private final Set<Tree> reachableNodes = new HashSet<>();
 
   /**
-   * The result of the flow analysis. Invariant:
+   * The merged result of all the analyses performed in the current compilation unit. Invariant:
    *
    * <pre>
    *  scannedClasses.get(c) == FINISHED for some class c &rArr; flowResult != null