Add misc doc link fixes and update old comment

This commit is contained in:
Mark McCaskey
2019-12-19 16:22:51 -05:00
parent 0daaa75a70
commit ad8945a555
4 changed files with 10 additions and 10 deletions

View File

@ -105,8 +105,6 @@ pub mod prelude {
/// WebAssembly binary code. This function is useful if it /// WebAssembly binary code. This function is useful if it
/// is necessary to a compile a module before it can be instantiated /// is necessary to a compile a module before it can be instantiated
/// and must be used if you wish to use a different backend from the default. /// and must be used if you wish to use a different backend from the default.
///
/// [`Module`]: struct.Module.html
pub fn compile_with( pub fn compile_with(
wasm: &[u8], wasm: &[u8],
compiler: &dyn backend::Compiler, compiler: &dyn backend::Compiler,

View File

@ -101,11 +101,9 @@ impl ModuleInfo {
/// A compiled WebAssembly module. /// A compiled WebAssembly module.
/// ///
/// `Module` is returned by the [`compile`] and /// `Module` is returned by the [`compile_with`][] function.
/// [`compile_with`] functions.
/// ///
/// [`compile`]: fn.compile.html /// [`compile_with`]: crate::compile_with
/// [`compile_with`]: fn.compile_with.html
pub struct Module { pub struct Module {
inner: Arc<ModuleInner>, inner: Arc<ModuleInner>,
} }

View File

@ -79,13 +79,17 @@
//! # Additional Notes: //! # Additional Notes:
//! //!
//! The `wasmer-runtime` is build to support compiler multiple backends. //! The `wasmer-runtime` is build to support compiler multiple backends.
//! Currently, we support the [Cranelift] compiler with the [`wasmer-clif-backend`] crate. //! Currently, we support the Singlepass, [Cranelift], and LLVM compilers
//! with the [`wasmer-singlepass-backend`], [`wasmer-clif-backend`], and
//! wasmer-llvm-backend crates, respectively.
//! //!
//! You can specify the compiler you wish to use with the [`compile_with`] function. //! You can specify the compiler you wish to use with the [`compile_with`]
//! function or use the default with the [`compile`] function.
//! //!
//! [Cranelift]: https://github.com/CraneStation/cranelift //! [Cranelift]: https://github.com/CraneStation/cranelift
//! [LLVM]: https://llvm.org
//! [`wasmer-singlepass-backend`]: https://crates.io/crates/wasmer-singlepass-backend
//! [`wasmer-clif-backend`]: https://crates.io/crates/wasmer-clif-backend //! [`wasmer-clif-backend`]: https://crates.io/crates/wasmer-clif-backend
//! [`compile_with`]: fn.compile_with.html
pub use wasmer_runtime_core::backend::{Backend, Features}; pub use wasmer_runtime_core::backend::{Backend, Features};
pub use wasmer_runtime_core::codegen::{MiddlewareChain, StreamingCompiler}; pub use wasmer_runtime_core::codegen::{MiddlewareChain, StreamingCompiler};

View File

@ -81,7 +81,7 @@ pub fn generate_import_object(
} }
/// Create an [`ImportObject`] with an existing [`WasiState`]. [`WasiState`] /// Create an [`ImportObject`] with an existing [`WasiState`]. [`WasiState`]
/// can be constructed from a [`WasiStateBuilder`]. /// can be constructed from a [`WasiStateBuilder`](state::WasiStateBuilder).
pub fn generate_import_object_from_state( pub fn generate_import_object_from_state(
wasi_state: WasiState, wasi_state: WasiState,
version: WasiVersion, version: WasiVersion,