Documentation for checkMemberReferenceReceivers() (#5819)

typetools · May 1, 2023 · 5218e20 · 5218e20
1 parent 025d4bb
commit 5218e20
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/framework/src/main/java/org/checkerframework/common/basetype/BaseTypeVisitor.java b/framework/src/main/java/org/checkerframework/common/basetype/BaseTypeVisitor.java
@@ -3962,6 +3962,12 @@ private void checkPreAndPostConditions() {
           overriderType, overriddenType, superCPostFalse2, subCPostFalse2, postfalsemsg);
     }
 
+    /**
+     * Issue a "methodref.receiver" or "methodref.receiver.bound" error if the receiver for the
+     * method reference does not satify overriding rules.
+     *
+     * @return true if the override is legal
+     */
     private boolean checkMemberReferenceReceivers() {
       if (overriderType.getKind() == TypeKind.ARRAY) {
         // Assume the receiver for all method on arrays are @Top