From 257e9cef66666cfce885fb44ca8f1edad2c79ac6 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Sun, 18 Jul 2021 15:22:09 +0200 Subject: [PATCH] docify some comments --- src/machine.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/machine.rs b/src/machine.rs index 03f53033b79..62c1a93079c 100644 --- a/src/machine.rs +++ b/src/machine.rs @@ -123,15 +123,15 @@ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub struct Tag { pub alloc_id: AllocId, - // Stacked Borrows tag. + /// Stacked Borrows tag. pub sb: SbTag, } impl Provenance for Tag { - // We use absolute addresses in the `offset` of a `Pointer`. + /// We use absolute addresses in the `offset` of a `Pointer`. const OFFSET_IS_ADDR: bool = true; - // We cannot err on partial overwrites, it happens too often in practice (due to unions). + /// We cannot err on partial overwrites, it happens too often in practice (due to unions). const ERR_ON_PARTIAL_PTR_OVERWRITE: bool = false; fn fmt(ptr: &Pointer, f: &mut fmt::Formatter<'_>) -> fmt::Result {