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

Commit

Permalink
Fix documentation warnings in ConstantPool
Browse files Browse the repository at this point in the history
  • Loading branch information
abrown authored and bnjbvr committed Aug 29, 2019
1 parent 6516250 commit 2f146c6
Showing 1 changed file with 6 additions and 4 deletions.
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

0 comments on commit 2f146c6

Please sign in to comment.