Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Fix documentation warnings in ConstantPool #952

Merged
merged 1 commit into from
Aug 29, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions cranelift-codegen/src/ir/constant.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ pub type ConstantOffset = u32;
/// Inner type for storing data and offset together in the constant pool. The offset is optional
/// because it must be set relative to the function code size (i.e. constants are emitted after the
/// function body); because the function is not yet compiled when constants are inserted,
/// [set_offset](ir::ConstantPool::set_offset) must be called once a constant's offset from the
/// beginning of the function is known (see [relaxation.rs](binemit::relaxation)).
/// [`set_offset`](crate::ir::ConstantPool::set_offset) must be called once a constant's
/// offset from the beginning of the function is known (see
/// [`relaxation.rs`](crate::binemit::relaxation)).
#[derive(Clone)]
pub struct ConstantPoolEntry {
data: ConstantData,
Expand All @@ -43,8 +44,9 @@ impl ConstantPoolEntry {
}
}

/// Maintains the mapping between a constant handle (i.e. [Constant](ir::entities::Constant)) and
/// its constant data (i.e. [ConstantData](ir::constant::ConstantData)).
/// Maintains the mapping between a constant handle (i.e.
/// [`Constant`](crate::ir::Constant)) and its constant data (i.e.
/// [`ConstantData`](crate::ir::ConstantData)).
#[derive(Clone)]
pub struct ConstantPool {
/// This mapping maintains the insertion order as long as Constants are created with sequentially increasing integers.
Expand Down