From ec9f9d0a8e737f507d5ece3a4da2e98bfa3c2ffc Mon Sep 17 00:00:00 2001 From: Sergey Pepyakin Date: Fri, 26 Jan 2018 18:20:54 +0300 Subject: [PATCH] Some rustdoc headers. --- src/func.rs | 2 +- src/global.rs | 2 +- src/memory.rs | 2 +- src/table.rs | 2 +- src/types.rs | 3 ++- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/func.rs b/src/func.rs index ce413ba..46aebd1 100644 --- a/src/func.rs +++ b/src/func.rs @@ -10,7 +10,7 @@ use module::ModuleInstance; use common::stack::StackWithLimit; 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. /// diff --git a/src/global.rs b/src/global.rs index 1edd774..e58e543 100644 --- a/src/global.rs +++ b/src/global.rs @@ -5,7 +5,7 @@ use Error; use types::ValueType; 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. /// diff --git a/src/memory.rs b/src/memory.rs index cf25233..9611a24 100644 --- a/src/memory.rs +++ b/src/memory.rs @@ -13,7 +13,7 @@ pub const LINEAR_MEMORY_PAGE_SIZE: u32 = 65536; /// Maximal number of pages. 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. /// diff --git a/src/table.rs b/src/table.rs index a4f8ad5..eac4b0b 100644 --- a/src/table.rs +++ b/src/table.rs @@ -7,7 +7,7 @@ use Error; use func::FuncRef; use module::check_limits; -/// Reference to a [`TableInstance`]. +/// Reference to a table (See [`TableInstance`] for details). /// /// This reference has a reference-counting semantics. /// diff --git a/src/types.rs b/src/types.rs index 7e1e185..f0c63a3 100644 --- a/src/types.rs +++ b/src/types.rs @@ -3,13 +3,14 @@ use std::borrow::Cow; use parity_wasm::elements::{ 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]. /// /// Two signatures are considered equal if they have equal list of parameters and equal return types. /// /// [type]: enum.ValueType.html +/// [function]: struct.FuncInstance.html #[derive(Debug, Clone, PartialEq, Eq)] pub struct Signature { params: Cow<'static, [ValueType]>,