turn comments into doc-comments

This commit is contained in:
Ralf Jung
2019-05-29 11:51:43 +02:00
parent 6dd9389008
commit 0f96dd51c5
+9 -3
View File
@@ -138,9 +138,11 @@ fn check_data(data: u128, size: u8) {
"Scalar value {:#x} exceeds size of {} bytes", data, size);
}
/// Tag this scalar with `new_tag` if it is a pointer, leave it unchanged otherwise.
///
/// Used by `MemPlace::replace_tag`.
#[inline]
pub fn with_tag<Tag>(self, new_tag: Tag) -> Scalar<Tag> {
// Used by `MemPlace::replace_tag`
match self {
Scalar::Ptr(ptr) => Scalar::Ptr(ptr.with_tag(new_tag)),
Scalar::Raw { data, size } => Scalar::Raw { data, size },
@@ -149,9 +151,11 @@ pub fn with_tag<Tag>(self, new_tag: Tag) -> Scalar<Tag> {
}
impl<'tcx, Tag> Scalar<Tag> {
/// Erase the tag from the scalar, if any.
///
/// Used by error reporting code to avoid having the error type depend on `Tag`.
#[inline]
pub fn erase_tag(self) -> Scalar {
// Used by error reporting code to avoid having the error type depend on `Tag`
match self {
Scalar::Ptr(ptr) => Scalar::Ptr(ptr.erase_tag()),
Scalar::Raw { data, size } => Scalar::Raw { data, size },
@@ -472,10 +476,12 @@ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
}
impl<'tcx, Tag> ScalarMaybeUndef<Tag> {
/// Erase the tag from the scalar, if any.
///
/// Used by error reporting code to avoid having the error type depend on `Tag`.
#[inline]
pub fn erase_tag(self) -> ScalarMaybeUndef
{
// Used by error reporting code to avoid having the error type depend on `Tag`
match self {
ScalarMaybeUndef::Scalar(s) => ScalarMaybeUndef::Scalar(s.erase_tag()),
ScalarMaybeUndef::Undef => ScalarMaybeUndef::Undef,