T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation warnings in ConstantPool

Browse Source
This commit is contained in:
Andrew Brown
2019-08-28 09:18:43 -07:00
committed by Benjamin Bouvier
parent 04b10b3fde
commit 4e7226ddca
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cranelift/codegen/src/ir/constant.rs
View File

@@ -19,8 +19,9 @@ pub type ConstantOffset = u32;
/// Inner type for storing data and offset together in the constant pool. The offset is optional /// 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 /// 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, /// 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 /// [`set_offset`](crate::ir::ConstantPool::set_offset) must be called once a constant's
/// beginning of the function is known (see [relaxation.rs](binemit::relaxation)). /// offset from the beginning of the function is known (see
/// [`relaxation.rs`](crate::binemit::relaxation)).
#[derive(Clone)] #[derive(Clone)]
pub struct ConstantPoolEntry { pub struct ConstantPoolEntry {
data: ConstantData, data: ConstantData,
@@ -43,8 +44,9 @@ impl ConstantPoolEntry {
} }
} }
/// Maintains the mapping between a constant handle (i.e. [Constant](ir::entities::Constant)) and /// Maintains the mapping between a constant handle (i.e.
/// its constant data (i.e. [ConstantData](ir::constant::ConstantData)). /// [`Constant`](crate::ir::Constant)) and its constant data (i.e.
/// [`ConstantData`](crate::ir::ConstantData)).
#[derive(Clone)] #[derive(Clone)]
pub struct ConstantPool { pub struct ConstantPool {
/// This mapping maintains the insertion order as long as Constants are created with sequentially increasing integers. /// This mapping maintains the insertion order as long as Constants are created with sequentially increasing integers.