chain: touch up docs
This commit is contained in:
parent
ce1e81b274
commit
dcc1e19129
|
|
@ -1,12 +1,13 @@
|
||||||
//! Blockchain-related datastructures for Zebra. 🦓
|
//! Core Zcash data structures. 🦓
|
||||||
//!
|
//!
|
||||||
//! $$a^2 + b^2 = c^2$$
|
//! This crate provides definitions of core datastructures for Zcash, such as
|
||||||
|
//! blocks, transactions, addresses, etc.
|
||||||
|
|
||||||
#![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
|
#![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
|
||||||
#![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
|
#![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
|
||||||
#![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_chain")]
|
#![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_chain")]
|
||||||
//#![deny(missing_docs)]
|
|
||||||
#![allow(clippy::try_err)]
|
#![allow(clippy::try_err)]
|
||||||
|
#![deny(missing_docs)]
|
||||||
|
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
extern crate serde;
|
extern crate serde;
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
//! The consensus parameters for each Zcash network.
|
//! Consensus parameters for each Zcash network.
|
||||||
//!
|
//!
|
||||||
//! This module contains the consensus parameters which are required for
|
//! This module contains the consensus parameters which are required for
|
||||||
//! parsing.
|
//! parsing.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
//! Primitives used in Zcash structures.
|
//! External primitives used in Zcash structures.
|
||||||
//!
|
//!
|
||||||
//! This contains re-exports of libraries used in the public API, as well as stub
|
//! This contains re-exports of libraries used in the public API, as well as stub
|
||||||
//! definitions of primitive types which must be represented in this library but
|
//! definitions of primitive types which must be represented in this library but
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
//! Serialization for Zcash.
|
//! Consensus-critical serialization.
|
||||||
//!
|
//!
|
||||||
//! This module contains four traits: `ZcashSerialize` and `ZcashDeserialize`,
|
//! This module contains four traits: `ZcashSerialize` and `ZcashDeserialize`,
|
||||||
//! analogs of the Serde `Serialize` and `Deserialize` traits but intended for
|
//! analogs of the Serde `Serialize` and `Deserialize` traits but intended for
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
//! Transaction types.
|
//! Transactions and transaction-related structures.
|
||||||
|
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
//! Transparent (Bitcoin-inherited) functionality.
|
//! Transparent-related (Bitcoin-inherited) functionality.
|
||||||
|
|
||||||
mod address;
|
mod address;
|
||||||
mod keys;
|
mod keys;
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue