Documentation improvements (#5822)

typetools · May 1, 2023 · 58cea05 · 58cea05
1 parent 9c9238a
commit 58cea05
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/checker-qual/src/main/java/org/checkerframework/checker/lock/qual/GuardSatisfied.java b/checker-qual/src/main/java/org/checkerframework/checker/lock/qual/GuardSatisfied.java
@@ -36,8 +36,10 @@
 @SubtypeOf(GuardedByUnknown.class) // TODO: Should @GuardSatisfied be in its own hierarchy?
 public @interface GuardSatisfied {
   /**
-   * The index on the GuardSatisfied polymorphic qualifier. Defaults to -1 so that the user can
-   * write any index starting from 0.
+   * The index on the GuardSatisfied polymorphic qualifier, if any. Defaults to -1 so that, if the
+   * user writes 0, that is different than writing no index. Writing no index is the usual case.
+   *
+   * @return the index on the GuardSatisfied polymorphic qualifier, or -1 if none
    */
   int value() default -1;
 }
diff --git a/.../java/org/checkerframework/checker/initialization/InitializationAnnotatedTypeFactory.java b/.../java/org/checkerframework/checker/initialization/InitializationAnnotatedTypeFactory.java
@@ -924,7 +924,7 @@ protected AnnotationMirror leastUpperBoundInitialization(
     }
 
     /**
-     * Returns the least upper bound of two types.
+     * Returns the least upper bound of two Java basetypes (without annotations).
      *
      * @param a the first argument
      * @param b the second argument