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

Fix broken API doc links (#1020)

Browse Source 
Also enable the lint to guarantee they stay un-broken.
This commit is contained in:
Alex Crichton
2020-02-28 12:44:27 -06:00
committed by GitHub
parent 121bbd3656
commit 0dbfad3aa7
4 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
crates/api/src/frame_info.rs
View File

@@ -134,6 +134,8 @@ impl Drop for GlobalFrameInfoRegistration {
/// Whenever a WebAssembly trap occurs an instance of [`Trap`] is created. Each /// Whenever a WebAssembly trap occurs an instance of [`Trap`] is created. Each
/// [`Trap`] has a backtrace of the WebAssembly frames that led to the trap, and /// [`Trap`] has a backtrace of the WebAssembly frames that led to the trap, and
/// each frame is described by this structure. /// each frame is described by this structure.
///
/// [`Trap`]: crate::Trap
#[derive(Debug)] #[derive(Debug)]
pub struct FrameInfo { pub struct FrameInfo {
module_name: Option<String>, module_name: Option<String>,

3
crates/api/src/instance.rs
View File

@@ -109,6 +109,7 @@ impl Instance {
/// ///
/// [inst]: https://webassembly.github.io/spec/core/exec/modules.html#exec-instantiation /// [inst]: https://webassembly.github.io/spec/core/exec/modules.html#exec-instantiation
/// [issue]: https://github.com/bytecodealliance/wasmtime/issues/727 /// [issue]: https://github.com/bytecodealliance/wasmtime/issues/727
/// [`ExternType`]: crate::ExternType
pub fn new(module: &Module, imports: &[Extern]) -> Result<Instance, Error> { pub fn new(module: &Module, imports: &[Extern]) -> Result<Instance, Error> {
let store = module.store(); let store = module.store();
let config = store.engine().config(); let config = store.engine().config();
@@ -158,7 +159,7 @@ impl Instance {
/// they're simply the values that are exported. To learn the value of each /// they're simply the values that are exported. To learn the value of each
/// export you'll need to consult [`Module::exports`]. The list returned /// export you'll need to consult [`Module::exports`]. The list returned
/// here maps 1:1 with the list that [`Module::exports`] returns, and /// here maps 1:1 with the list that [`Module::exports`] returns, and
/// [`ExportType`] contains the name of each export. /// [`ExportType`](crate::ExportType) contains the name of each export.
pub fn exports(&self) -> &[Extern] { pub fn exports(&self) -> &[Extern] {
&self.exports &self.exports
} }

2
crates/api/src/lib.rs
View File

@@ -6,7 +6,7 @@
//! and there to implement Rust idioms. This crate also defines the actual C API //! and there to implement Rust idioms. This crate also defines the actual C API
//! itself for consumption from other languages. //! itself for consumption from other languages.
#![deny(missing_docs)] #![deny(missing_docs, intra_doc_link_resolution_failure)]
mod callable; mod callable;
mod externals; mod externals;

2
crates/api/src/module.rs
View File

@@ -234,7 +234,7 @@ impl Module {
/// indicate what should be valid and what shouldn't be. /// indicate what should be valid and what shouldn't be.
/// ///
/// Validation automatically happens as part of [`Module::new`], but is a /// Validation automatically happens as part of [`Module::new`], but is a
/// requirement for [`Module::new_unchecked`] to be safe. /// requirement for [`Module::from_binary_unchecked`] to be safe.
/// ///
/// # Errors /// # Errors
/// ///