Merge pull request #116 from jeandudey/2018-08-08-module-docs

Fix modules documentation title.

src/blockdata/block.rs

@@ -12,7 +12,7 @@
 // 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,
 //! which attaches to an earlier block to form the blockchain. This

src/blockdata/constants.rs

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

src/blockdata/mod.rs

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

src/blockdata/opcodes.rs

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

src/blockdata/script.rs

@@ -12,7 +12,7 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! # Script
+//! Script
 //!
 //! 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,

src/blockdata/transaction.rs

@@ -12,7 +12,7 @@
 // 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
 //! transaction outputs and produces new ones, satisfying the condition to spend

src/macros.rs

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

src/network/address.rs

@@ -12,7 +12,7 @@
 // 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
 //! network addresses in Bitcoin messages.

src/network/consensus_params.rs

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

src/network/encodable.rs

@@ -12,7 +12,7 @@
 // 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
 //! normalization for endianness, etc., to ensure that the encoding

src/network/listener.rs

@@ -12,7 +12,7 @@
 // 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
 //! to connect to a peer, send network messages, and receive Bitcoin data.

src/network/message.rs

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

src/network/message_blockdata.rs

@@ -12,7 +12,7 @@
 // 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
 //! Bitcoin data (blocks and transactions) around.

src/network/message_network.rs

@@ -12,7 +12,7 @@
 // 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
 //! capabilities

src/network/mod.rs

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

src/network/serialize.rs

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

src/network/socket.rs

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

src/test_macros.rs

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

src/util/address.rs

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

src/util/base58.rs

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

src/util/bip143.rs

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

src/util/bip32.rs

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

src/util/contracthash.rs

@@ -12,7 +12,8 @@
 // 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
 //! at http://blockstream.com/sidechains.pdf for details of
 //! what this does.

src/util/decimal.rs

@@ -12,7 +12,7 @@
 // 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
 //! amounts. For satoshi amounts (8 decimal places) the maximum

src/util/hash.rs

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

src/util/iter.rs

@@ -12,7 +12,7 @@
 // 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
 //! standard library.

src/util/misc.rs

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

src/util/mod.rs

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

src/util/privkey.rs

@@ -11,8 +11,9 @@
 // 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 util::Error;

src/util/uint.rs

@@ -12,7 +12,7 @@
 // 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.
 //! The functions here are designed to be fast.