Some rustdoc headers.
This commit is contained in:
parent
388e257444
commit
ec9f9d0a8e
|
@ -10,7 +10,7 @@ use module::ModuleInstance;
|
||||||
use common::stack::StackWithLimit;
|
use common::stack::StackWithLimit;
|
||||||
use common::{DEFAULT_FRAME_STACK_LIMIT, DEFAULT_VALUE_STACK_LIMIT};
|
use common::{DEFAULT_FRAME_STACK_LIMIT, DEFAULT_VALUE_STACK_LIMIT};
|
||||||
|
|
||||||
/// Reference to a [`FuncInstance`].
|
/// Reference to a function (See [`FuncInstance`] for details).
|
||||||
///
|
///
|
||||||
/// This reference has a reference-counting semantics.
|
/// This reference has a reference-counting semantics.
|
||||||
///
|
///
|
||||||
|
|
|
@ -5,7 +5,7 @@ use Error;
|
||||||
use types::ValueType;
|
use types::ValueType;
|
||||||
use parity_wasm::elements::{ValueType as EValueType};
|
use parity_wasm::elements::{ValueType as EValueType};
|
||||||
|
|
||||||
/// Reference to a [`GlobalInstance`].
|
/// Reference to a global variable (See [`GlobalInstance`] for details).
|
||||||
///
|
///
|
||||||
/// This reference has a reference-counting semantics.
|
/// This reference has a reference-counting semantics.
|
||||||
///
|
///
|
||||||
|
|
|
@ -13,7 +13,7 @@ pub const LINEAR_MEMORY_PAGE_SIZE: u32 = 65536;
|
||||||
/// Maximal number of pages.
|
/// Maximal number of pages.
|
||||||
const LINEAR_MEMORY_MAX_PAGES: u32 = 65536;
|
const LINEAR_MEMORY_MAX_PAGES: u32 = 65536;
|
||||||
|
|
||||||
/// Reference to a [`MemoryInstance`].
|
/// Reference to a memory (See [`MemoryInstance`] for details).
|
||||||
///
|
///
|
||||||
/// This reference has a reference-counting semantics.
|
/// This reference has a reference-counting semantics.
|
||||||
///
|
///
|
||||||
|
|
|
@ -7,7 +7,7 @@ use Error;
|
||||||
use func::FuncRef;
|
use func::FuncRef;
|
||||||
use module::check_limits;
|
use module::check_limits;
|
||||||
|
|
||||||
/// Reference to a [`TableInstance`].
|
/// Reference to a table (See [`TableInstance`] for details).
|
||||||
///
|
///
|
||||||
/// This reference has a reference-counting semantics.
|
/// This reference has a reference-counting semantics.
|
||||||
///
|
///
|
||||||
|
|
|
@ -3,13 +3,14 @@ use std::borrow::Cow;
|
||||||
use parity_wasm::elements::{
|
use parity_wasm::elements::{
|
||||||
FunctionType, ValueType as EValueType, GlobalType, TableType, MemoryType};
|
FunctionType, ValueType as EValueType, GlobalType, TableType, MemoryType};
|
||||||
|
|
||||||
/// Signature of a function.
|
/// Signature of a [function].
|
||||||
///
|
///
|
||||||
/// Signature of a function consists of zero or more parameter [types][type] and zero or one return [type].
|
/// Signature of a function consists of zero or more parameter [types][type] and zero or one return [type].
|
||||||
///
|
///
|
||||||
/// Two signatures are considered equal if they have equal list of parameters and equal return types.
|
/// Two signatures are considered equal if they have equal list of parameters and equal return types.
|
||||||
///
|
///
|
||||||
/// [type]: enum.ValueType.html
|
/// [type]: enum.ValueType.html
|
||||||
|
/// [function]: struct.FuncInstance.html
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
pub struct Signature {
|
pub struct Signature {
|
||||||
params: Cow<'static, [ValueType]>,
|
params: Cow<'static, [ValueType]>,
|
||||||
|
|
Loading…
Reference in New Issue