Fix modules documentation title.

Signed-off-by: Jean Pierre Dudey <jeandudey@hotmail.com>
This commit is contained in:
Jean Pierre Dudey 2018-08-08 17:38:50 -04:00
parent 45c699f005
commit 77c185d9ec
31 changed files with 35 additions and 32 deletions

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Bitcoin Block //! Bitcoin Block
//! //!
//! A block is a bundle of transactions with a proof-of-work attached, //! A block is a bundle of transactions with a proof-of-work attached,
//! which attaches to an earlier block to form the blockchain. This //! which attaches to an earlier block to form the blockchain. This

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Blockdata constants //! Blockdata constants
//! //!
//! This module provides various constants relating to the blockchain and //! This module provides various constants relating to the blockchain and
//! consensus code. In particular, it defines the genesis block and its //! consensus code. In particular, it defines the genesis block and its

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Blockdata //! Blockdata
//! //!
//! This module defines structions and functions for storing the blocks and //! This module defines structions and functions for storing the blocks and
//! transactions which make up the Bitcoin system. //! transactions which make up the Bitcoin system.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Opcodes //! Opcodes
//! //!
//! Bitcoin's script uses a stack-based assembly language. This module defines //! Bitcoin's script uses a stack-based assembly language. This module defines
//! all of the opcodes //! all of the opcodes

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Script //! Script
//! //!
//! Scripts define Bitcoin's digital signature scheme: a signature is formed //! Scripts define Bitcoin's digital signature scheme: a signature is formed
//! from a script (the second half of which is defined by a coin to be spent, //! from a script (the second half of which is defined by a coin to be spent,

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Bitcoin Transaction //! Bitcoin Transaction
//! //!
//! A transaction describes a transfer of money. It consumes previously-unspent //! A transaction describes a transfer of money. It consumes previously-unspent
//! transaction outputs and produces new ones, satisfying the condition to spend //! transaction outputs and produces new ones, satisfying the condition to spend

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Macros //! Macros
//! //!
//! Macros available to users of the Bitcoin library //! Macros available to users of the Bitcoin library

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Bitcoin network addresses //! Bitcoin network addresses
//! //!
//! This module defines the structures and functions needed to encode //! This module defines the structures and functions needed to encode
//! network addresses in Bitcoin messages. //! network addresses in Bitcoin messages.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Consensus parameters //! Consensus parameters
//! //!
//! This module provides predefined set of parameters for different chains. //! This module provides predefined set of parameters for different chains.
//! //!

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Network constants //! Network constants
//! //!
//! This module provides various constants relating to the Bitcoin network //! This module provides various constants relating to the Bitcoin network
//! protocol, such as protocol versioning and magic header bytes. //! protocol, such as protocol versioning and magic header bytes.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Consensus-encodable types //! Consensus-encodable types
//! //!
//! This is basically a replacement of the `Encodable` trait which does //! This is basically a replacement of the `Encodable` trait which does
//! normalization for endianness, etc., to ensure that the encoding //! normalization for endianness, etc., to ensure that the encoding

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Abstract Bitcoin listener //! Abstract Bitcoin listener
//! //!
//! This module defines a listener on the Bitcoin network which is able //! This module defines a listener on the Bitcoin network which is able
//! to connect to a peer, send network messages, and receive Bitcoin data. //! to connect to a peer, send network messages, and receive Bitcoin data.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Network message //! Network message
//! //!
//! This module defines the `Message` traits which are used //! This module defines the `Message` traits which are used
//! for (de)serializing Bitcoin objects for transmission on the network. It //! for (de)serializing Bitcoin objects for transmission on the network. It

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Blockdata network messages //! Blockdata network messages
//! //!
//! This module describes network messages which are used for passing //! This module describes network messages which are used for passing
//! Bitcoin data (blocks and transactions) around. //! Bitcoin data (blocks and transactions) around.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Network-related network messages //! Network-related network messages
//! //!
//! This module defines network messages which describe peers and their //! This module defines network messages which describe peers and their
//! capabilities //! capabilities

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Network Support //! Network Support
//! //!
//! This module defines support for (de)serialization and network transport //! This module defines support for (de)serialization and network transport
//! of Bitcoin data and network messages. //! of Bitcoin data and network messages.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Network Serialization //! Network Serialization
//! //!
//! This module defines the `Serializable` trait which is used for //! This module defines the `Serializable` trait which is used for
//! (de)serializing Bitcoin objects for transmission on the network. //! (de)serializing Bitcoin objects for transmission on the network.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Sockets //! Sockets
//! //!
//! This module provides support for low-level network communication. //! This module provides support for low-level network communication.
//! //!

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Macros //! Macros
//! //!
//! Internal macros used for unit tests //! Internal macros used for unit tests

View File

@ -11,7 +11,8 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Addresses //! Addresses
//!
//! Support for ordinary base58 Bitcoin addresses and private keys //! Support for ordinary base58 Bitcoin addresses and private keys
//! //!

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Base58 encoder and decoder //! Base58 encoder and decoder
use std::{error, fmt}; use std::{error, fmt};

View File

@ -11,7 +11,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # BIP143 Implementation //! BIP143 Implementation
//! //!
//! Implementation of BIP143 Segwit-style signatures. Should be sufficient //! Implementation of BIP143 Segwit-style signatures. Should be sufficient
//! to create signatures for Segwit transactions (which should be pushed into //! to create signatures for Segwit transactions (which should be pushed into

View File

@ -11,7 +11,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # BIP32 Implementation //! BIP32 Implementation
//! //!
//! Implementation of BIP32 hierarchical deterministic wallets, as defined //! Implementation of BIP32 hierarchical deterministic wallets, as defined
//! at https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki //! at https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki

View File

@ -12,7 +12,8 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Pay-to-contract-hash supporte //! Pay-to-contract-hash supporte
//!
//! See Appendix A of the Blockstream sidechains whitepaper //! See Appendix A of the Blockstream sidechains whitepaper
//! at http://blockstream.com/sidechains.pdf for details of //! at http://blockstream.com/sidechains.pdf for details of
//! what this does. //! what this does.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Floating-point decimal type //! Floating-point decimal type
//! //!
//! `i64`-based floating-point decimal type designed to hold Bitcoin //! `i64`-based floating-point decimal type designed to hold Bitcoin
//! amounts. For satoshi amounts (8 decimal places) the maximum //! amounts. For satoshi amounts (8 decimal places) the maximum

View File

@ -11,7 +11,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Hash functions //! Hash functions
//! //!
//! Utility functions related to hashing data, including merkleization //! Utility functions related to hashing data, including merkleization

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Iterator adaptors //! Iterator adaptors
//! //!
//! Iterator adaptors needed by Bitcoin but not provided by the Rust //! Iterator adaptors needed by Bitcoin but not provided by the Rust
//! standard library. //! standard library.

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Miscellaneous functions //! Miscellaneous functions
//! //!
//! Various utility functions //! Various utility functions

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Utility functions //! Utility functions
//! //!
//! Functions needed by all parts of the Bitcoin library //! Functions needed by all parts of the Bitcoin library

View File

@ -11,8 +11,9 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # private key //! Private key
//! A private key represents the secret data associated with its proposed use //!
//! A private key represents the secret data associated with its proposed use
//! //!
use std::str::FromStr; use std::str::FromStr;
use util::Error; use util::Error;

View File

@ -12,7 +12,7 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Big unsigned integer types //! Big unsigned integer types
//! //!
//! Implementation of a various large-but-fixed sized unsigned integer types. //! Implementation of a various large-but-fixed sized unsigned integer types.
//! The functions here are designed to be fast. //! The functions here are designed to be fast.