Add doc comment to check_bytes

oli-obk · oli-obk · commit aeb18d6c6ea2 · 2018-10-25T16:33:02.000+02:00
diff --git a/src/librustc/mir/interpret/allocation.rs b/src/librustc/mir/interpret/allocation.rs
@@ -285,6 +285,10 @@ impl<'tcx, Tag: Copy, Extra: AllocationExtra<Tag>> Allocation<Tag, Extra> {
         }
     }
 
+    /// Checks whether the target range does not have relocations on the edge of the range
+    ///
+    /// if `allow_ptr_and_undef` is `false`, also check whether the entire range contains
+    /// neither undefined bytes nor any relocations
     pub fn check_bytes(
         &self,
         cx: impl HasDataLayout,

Original file line number	Diff line number	Diff line change
`@@ -285,6 +285,10 @@ impl<'tcx, Tag: Copy, Extra: AllocationExtra<Tag>> Allocation<Tag, Extra> {`
`285`	`285`	`}`
`286`	`286`	`}`
`287`	`287`
	`288`	`+ /// Checks whether the target range does not have relocations on the edge of the range`
	`289`	`+ ///`
	`290`	+ /// if `allow_ptr_and_undef` is `false`, also check whether the entire range contains
	`291`	`+ /// neither undefined bytes nor any relocations`
`288`	`292`	`pub fn check_bytes(`
`289`	`293`	`&self,`
`290`	`294`	`cx: impl HasDataLayout,`