diff options
| author | Son Ho | 2022-10-27 11:52:48 +0200 |
|---|---|---|
| committer | Son HO | 2022-10-27 12:58:47 +0200 |
| commit | 5cdea01dea654713b887017efe80e620f8e14932 (patch) | |
| tree | cba45e978c02a20b09d164c5dcfbe55bd4e7ed42 /compiler/InterpreterBorrows.ml | |
| parent | c1b2b95bf5bfdf62b004bff4a729655663519448 (diff) | |
Fix some comment references
Diffstat (limited to '')
| -rw-r--r-- | compiler/InterpreterBorrows.ml | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/compiler/InterpreterBorrows.ml b/compiler/InterpreterBorrows.ml index 30c3b221..16f68d9e 100644 --- a/compiler/InterpreterBorrows.ml +++ b/compiler/InterpreterBorrows.ml @@ -224,7 +224,7 @@ let end_borrow_get_borrow (allowed_abs : V.AbstractionId.id option) Ok (ctx, !replaced_bc) with FoundPriority outers -> Error outers -(** Auxiliary function to end borrows. See [give_back]. +(** Auxiliary function to end borrows. See {!give_back}. When we end a mutable borrow, we need to "give back" the value it contained to its original owner by reinserting it at the proper position. @@ -475,7 +475,7 @@ let give_back_symbolic_value (_config : C.config) in update_intersecting_aproj_loans proj_regions proj_ty sv subst ctx -(** Auxiliary function to end borrows. See [give_back]. +(** Auxiliary function to end borrows. See {!give_back}. This function is similar to {!give_back_value} but gives back an {!V.avalue} (coming from an abstraction). @@ -577,7 +577,7 @@ let give_back_avalue_to_same_abstraction (_config : C.config) (* Return *) ctx -(** Auxiliary function to end borrows. See [give_back]. +(** Auxiliary function to end borrows. See {!give_back}. When we end a shared borrow, we need to remove the borrow id from the list of borrows to the shared value. @@ -704,7 +704,7 @@ let reborrow_shared (original_bid : V.BorrowId.id) (new_bid : V.BorrowId.id) assert !r; { ctx with env } -(** Auxiliary function: see [end_borrow] *) +(** Auxiliary function: see {!end_borrow} *) let give_back (config : C.config) (l : V.BorrowId.id) (bc : g_borrow_content) (ctx : C.eval_ctx) : C.eval_ctx = (* Debug *) @@ -1430,7 +1430,7 @@ let end_outer_borrow config : V.BorrowId.id -> cm_fun = let end_outer_borrows config : V.BorrowId.Set.t -> cm_fun = end_borrows config [] None -(** Helper function: see [activate_inactivated_mut_borrow]. +(** Helper function: see {!activate_inactivated_mut_borrow}. This function updates the shared loan to a mutable loan (we then update the borrow with another helper). Of course, the shared loan must contain |