Fix documentation link issues

This commit is contained in:
Andrew Brown
2019-10-31 09:17:27 -07:00
parent f19456640c
commit 96f5a6b561
2 changed files with 10 additions and 8 deletions

View File

@@ -390,10 +390,12 @@ impl VarPool {
} }
} }
/// Contains constants created in the AST that must be inserted into the true [ConstantPool] /// Contains constants created in the AST that must be inserted into the true [ConstantPool] when
/// (cranelift_codegen::ir::ConstantPool) when the legalizer code is generated. The constant data /// the legalizer code is generated. The constant data is named in the order it is inserted;
/// is named in the order it is inserted; inserting data using [insert] /// inserting data using [insert] will avoid duplicates.
/// (cranelift_codegen_meta::cdsl::ast::insert) will avoid duplicates. ///
/// [ConstantPool]: ../../../cranelift_codegen/ir/constant/struct.ConstantPool.html
/// [insert]: ConstPool::insert
pub(crate) struct ConstPool { pub(crate) struct ConstPool {
pool: Vec<Vec<u8>>, pool: Vec<Vec<u8>>,
} }

View File

@@ -21,8 +21,9 @@ use cranelift_entity::EntityRef;
/// This type describes the actual constant data. Note that the bytes stored in this structure are /// This type describes the actual constant data. Note that the bytes stored in this structure are
/// expected to be in little-endian order; this is due to ease-of-use when interacting with /// expected to be in little-endian order; this is due to ease-of-use when interacting with
/// WebAssembly values, which are [little-endian by design] /// WebAssembly values, which are [little-endian by design].
/// (https://github.com/WebAssembly/design/blob/master/Portability.md). ///
/// [little-endian by design]: https://github.com/WebAssembly/design/blob/master/Portability.md
#[derive(Clone, Hash, Eq, PartialEq, Debug, Default)] #[derive(Clone, Hash, Eq, PartialEq, Debug, Default)]
pub struct ConstantData(Vec<u8>); pub struct ConstantData(Vec<u8>);
@@ -116,8 +117,7 @@ impl fmt::Display for ConstantData {
impl FromStr for ConstantData { impl FromStr for ConstantData {
type Err = &'static str; type Err = &'static str;
/// Parse a hexadecimal string to `ConstantData`. This is the inverse of [ConstantData::fmt] /// Parse a hexadecimal string to `ConstantData`. This is the inverse of `Display::fmt`.
/// (cranelift_codegen::ir::ConstantData::fmt).
/// ///
/// ``` /// ```
/// use cranelift_codegen::ir::ConstantData; /// use cranelift_codegen::ir::ConstantData;