[docs] Replace all 'allow(missing_docs)' with basic docs

This commit is contained in:
Steve Myers 2020-12-16 13:57:01 -08:00
parent 8cfbf1f0a2
commit fb5c70fc64
No known key found for this signature in database
GPG Key ID: 8105A46B22C2D051
4 changed files with 29 additions and 29 deletions

View File

@ -113,15 +113,15 @@ macro_rules! impl_inner_method {
pub enum AnyBlockchain { pub enum AnyBlockchain {
#[cfg(feature = "electrum")] #[cfg(feature = "electrum")]
#[cfg_attr(docsrs, doc(cfg(feature = "electrum")))] #[cfg_attr(docsrs, doc(cfg(feature = "electrum")))]
#[allow(missing_docs)] /// Electrum client
Electrum(electrum::ElectrumBlockchain), Electrum(electrum::ElectrumBlockchain),
#[cfg(feature = "esplora")] #[cfg(feature = "esplora")]
#[cfg_attr(docsrs, doc(cfg(feature = "esplora")))] #[cfg_attr(docsrs, doc(cfg(feature = "esplora")))]
#[allow(missing_docs)] /// Esplora client
Esplora(esplora::EsploraBlockchain), Esplora(esplora::EsploraBlockchain),
#[cfg(feature = "compact_filters")] #[cfg(feature = "compact_filters")]
#[cfg_attr(docsrs, doc(cfg(feature = "compact_filters")))] #[cfg_attr(docsrs, doc(cfg(feature = "compact_filters")))]
#[allow(missing_docs)] /// Compact filters client
CompactFilters(compact_filters::CompactFiltersBlockchain), CompactFilters(compact_filters::CompactFiltersBlockchain),
} }
@ -188,15 +188,15 @@ impl_from!(compact_filters::CompactFiltersBlockchain, AnyBlockchain, CompactFilt
pub enum AnyBlockchainConfig { pub enum AnyBlockchainConfig {
#[cfg(feature = "electrum")] #[cfg(feature = "electrum")]
#[cfg_attr(docsrs, doc(cfg(feature = "electrum")))] #[cfg_attr(docsrs, doc(cfg(feature = "electrum")))]
#[allow(missing_docs)] /// Electrum client
Electrum(electrum::ElectrumBlockchainConfig), Electrum(electrum::ElectrumBlockchainConfig),
#[cfg(feature = "esplora")] #[cfg(feature = "esplora")]
#[cfg_attr(docsrs, doc(cfg(feature = "esplora")))] #[cfg_attr(docsrs, doc(cfg(feature = "esplora")))]
#[allow(missing_docs)] /// Esplora client
Esplora(esplora::EsploraBlockchainConfig), Esplora(esplora::EsploraBlockchainConfig),
#[cfg(feature = "compact_filters")] #[cfg(feature = "compact_filters")]
#[cfg_attr(docsrs, doc(cfg(feature = "compact_filters")))] #[cfg_attr(docsrs, doc(cfg(feature = "compact_filters")))]
#[allow(missing_docs)] /// Compact filters client
CompactFilters(compact_filters::CompactFiltersBlockchainConfig), CompactFilters(compact_filters::CompactFiltersBlockchainConfig),
} }

View File

@ -89,11 +89,11 @@ macro_rules! impl_inner_method {
/// See [this module](crate::database::any)'s documentation for a usage example. /// See [this module](crate::database::any)'s documentation for a usage example.
#[derive(Debug)] #[derive(Debug)]
pub enum AnyDatabase { pub enum AnyDatabase {
#[allow(missing_docs)] /// In-memory ephemeral database
Memory(memory::MemoryDatabase), Memory(memory::MemoryDatabase),
#[cfg(feature = "key-value-db")] #[cfg(feature = "key-value-db")]
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))] #[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
#[allow(missing_docs)] /// Simple key-value embedded database based on [`sled`]
Sled(sled::Tree), Sled(sled::Tree),
} }
@ -102,11 +102,11 @@ impl_from!(sled::Tree, AnyDatabase, Sled, #[cfg(feature = "key-value-db")]);
/// Type that contains any of the [`BatchDatabase::Batch`] types defined by the library /// Type that contains any of the [`BatchDatabase::Batch`] types defined by the library
pub enum AnyBatch { pub enum AnyBatch {
#[allow(missing_docs)] /// In-memory ephemeral database
Memory(<memory::MemoryDatabase as BatchDatabase>::Batch), Memory(<memory::MemoryDatabase as BatchDatabase>::Batch),
#[cfg(feature = "key-value-db")] #[cfg(feature = "key-value-db")]
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))] #[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
#[allow(missing_docs)] /// Simple key-value embedded database based on [`sled`]
Sled(<sled::Tree as BatchDatabase>::Batch), Sled(<sled::Tree as BatchDatabase>::Batch),
} }
@ -364,7 +364,7 @@ pub enum AnyDatabaseConfig {
Memory(()), Memory(()),
#[cfg(feature = "key-value-db")] #[cfg(feature = "key-value-db")]
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))] #[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
#[allow(missing_docs)] /// Simple key-value embedded database based on [`sled`]
Sled(SledDbConfiguration), Sled(SledDbConfiguration),
} }

View File

@ -78,15 +78,15 @@ pub enum Error {
/// ///
/// [`TxBuilder::add_global_xpubs`]: crate::wallet::tx_builder::TxBuilder::add_global_xpubs /// [`TxBuilder::add_global_xpubs`]: crate::wallet::tx_builder::TxBuilder::add_global_xpubs
MissingKeyOrigin(String), MissingKeyOrigin(String),
#[allow(missing_docs)] /// Error while working with [`keys`](crate::keys)
Key(crate::keys::KeyError), Key(crate::keys::KeyError),
/// Descriptor checksum mismatch /// Descriptor checksum mismatch
ChecksumMismatch, ChecksumMismatch,
/// Spending policy is not compatible with this [`KeychainKind`](crate::types::KeychainKind) /// Spending policy is not compatible with this [`KeychainKind`](crate::types::KeychainKind)
SpendingPolicyRequired(crate::types::KeychainKind), SpendingPolicyRequired(crate::types::KeychainKind),
#[allow(missing_docs)] /// Error while extracting and manipulating policies
InvalidPolicyPathError(crate::descriptor::policy::PolicyError), InvalidPolicyPathError(crate::descriptor::policy::PolicyError),
#[allow(missing_docs)] /// Signing error
Signer(crate::wallet::signer::SignerError), Signer(crate::wallet::signer::SignerError),
// Blockchain interface errors // Blockchain interface errors
@ -101,23 +101,23 @@ pub enum Error {
/// Requested outpoint doesn't exist in the tx (vout greater than available outputs) /// Requested outpoint doesn't exist in the tx (vout greater than available outputs)
InvalidOutpoint(OutPoint), InvalidOutpoint(OutPoint),
#[allow(missing_docs)] /// Error related to the parsing and usage of descriptors
Descriptor(crate::descriptor::error::Error), Descriptor(crate::descriptor::error::Error),
#[allow(missing_docs)] /// Error that can be returned to fail the validation of an address
AddressValidator(crate::wallet::address_validator::AddressValidatorError), AddressValidator(crate::wallet::address_validator::AddressValidatorError),
#[allow(missing_docs)] /// Encoding error
Encode(bitcoin::consensus::encode::Error), Encode(bitcoin::consensus::encode::Error),
#[allow(missing_docs)] /// Miniscript error
Miniscript(miniscript::Error), Miniscript(miniscript::Error),
#[allow(missing_docs)] /// BIP32 error
BIP32(bitcoin::util::bip32::Error), BIP32(bitcoin::util::bip32::Error),
#[allow(missing_docs)] /// An ECDSA error
Secp256k1(bitcoin::secp256k1::Error), Secp256k1(bitcoin::secp256k1::Error),
#[allow(missing_docs)] /// Error serializing or deserializing JSON data
JSON(serde_json::Error), JSON(serde_json::Error),
#[allow(missing_docs)] /// Hex decoding error
Hex(bitcoin::hashes::hex::Error), Hex(bitcoin::hashes::hex::Error),
#[allow(missing_docs)] /// Partially signed bitcoin transaction error
PSBT(bitcoin::util::psbt::Error), PSBT(bitcoin::util::psbt::Error),
//KeyMismatch(bitcoin::secp256k1::PublicKey, bitcoin::secp256k1::PublicKey), //KeyMismatch(bitcoin::secp256k1::PublicKey, bitcoin::secp256k1::PublicKey),
@ -128,16 +128,16 @@ pub enum Error {
//Uncapable(crate::blockchain::Capability), //Uncapable(crate::blockchain::Capability),
//MissingCachedAddresses, //MissingCachedAddresses,
#[cfg(feature = "electrum")] #[cfg(feature = "electrum")]
#[allow(missing_docs)] /// Electrum client error
Electrum(electrum_client::Error), Electrum(electrum_client::Error),
#[cfg(feature = "esplora")] #[cfg(feature = "esplora")]
#[allow(missing_docs)] /// Esplora client error
Esplora(crate::blockchain::esplora::EsploraError), Esplora(crate::blockchain::esplora::EsploraError),
#[allow(missing_docs)]
#[cfg(feature = "compact_filters")] #[cfg(feature = "compact_filters")]
/// Compact filters client error)
CompactFilters(crate::blockchain::compact_filters::CompactFiltersError), CompactFilters(crate::blockchain::compact_filters::CompactFiltersError),
#[cfg(feature = "key-value-db")] #[cfg(feature = "key-value-db")]
#[allow(missing_docs)] /// Sled database error
Sled(sled::Error), Sled(sled::Error),
} }

View File

@ -684,9 +684,9 @@ pub enum KeyError {
/// Custom error message /// Custom error message
Message(String), Message(String),
#[allow(missing_docs)] /// BIP32 error
BIP32(bitcoin::util::bip32::Error), BIP32(bitcoin::util::bip32::Error),
#[allow(missing_docs)] /// Miniscript error
Miniscript(miniscript::Error), Miniscript(miniscript::Error),
} }