[docs] Add the docs to the `keys` module

diff --git a/src/keys/mod.rs b/src/keys/mod.rs
index 2f0b8610c4b3042d48ecd6d12ba915e1b5adcf74..f8e36aaddc4519d61b2f84484f981436886005c2 100644 (file)
--- a/src/keys/mod.rs
+++ b/src/keys/mod.rs
@@ -129,15 +129,19 @@ impl<Ctx: ScriptContext> DescriptorKey<Ctx> {
 /// Enum representation of the known valid [`ScriptContext`]s
 #[derive(Debug, Eq, PartialEq, Copy, Clone)]
 pub enum ScriptContextEnum {
+    /// Legacy scripts
     Legacy,
+    /// Segwitv0 scripts
     Segwitv0,
 }
 
 impl ScriptContextEnum {
+    /// Returns whether the script context is [`ScriptContextEnum::Legacy`]
     pub fn is_legacy(&self) -> bool {
         self == &ScriptContextEnum::Legacy
     }
 
+    /// Returns whether the script context is [`ScriptContextEnum::Segwitv0`]
     pub fn is_segwit_v0(&self) -> bool {
         self == &ScriptContextEnum::Segwitv0
     }
@@ -145,12 +149,15 @@ impl ScriptContextEnum {
 
 /// Trait that adds extra useful methods to [`ScriptContext`]s
 pub trait ExtScriptContext: ScriptContext {
+    /// Returns the [`ScriptContext`] as a [`ScriptContextEnum`]
     fn as_enum() -> ScriptContextEnum;
 
+    /// Returns whether the script context is [`Legacy`](miniscript::Legacy)
     fn is_legacy() -> bool {
         Self::as_enum().is_legacy()
     }
 
+    /// Returns whether the script context is [`Segwitv0`](miniscript::Segwitv0)
     fn is_segwit_v0() -> bool {
         Self::as_enum().is_segwit_v0()
     }
@@ -345,7 +352,7 @@ pub struct GeneratedKey<K, Ctx: ScriptContext> {
 }
 
 impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx> {
-    pub fn new(key: K, valid_networks: ValidNetworks) -> Self {
+    fn new(key: K, valid_networks: ValidNetworks) -> Self {
         GeneratedKey {
             key,
             valid_networks,
@@ -482,6 +489,7 @@ impl<Ctx: ScriptContext> GeneratableKey<Ctx> for bip32::ExtendedPrivKey {
 /// Defaults to creating compressed keys, which save on-chain bytes and fees
 #[derive(Debug, Copy, Clone)]
 pub struct PrivateKeyGenerateOptions {
+    /// Whether the generated key should be "compressed" or not
     pub compressed: bool,
 }
 
@@ -670,12 +678,19 @@ impl<Ctx: ScriptContext> ToDescriptorKey<Ctx> for PrivateKey {
 /// Errors thrown while working with [`keys`](crate::keys)
 #[derive(Debug)]
 pub enum KeyError {
+    /// The key cannot exist in the given script context
     InvalidScriptContext,
+    /// The key is not valid for the given network
     InvalidNetwork,
+    /// The key has an invalid checksum
     InvalidChecksum,
+
+    /// Custom error message
     Message(String),
 
+    #[allow(missing_docs)]
     BIP32(bitcoin::util::bip32::Error),
+    #[allow(missing_docs)]
     Miniscript(miniscript::Error),
 }
 

diff --git a/src/lib.rs b/src/lib.rs
index 64d79c429b737a8501540eb6b9b1243c5eac6dfa..01b993e26825dc0c1d0e71237448feddf62e35c7 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -256,7 +256,6 @@ pub mod database;
 pub mod descriptor;
 #[cfg(feature = "test-md-docs")]
 mod doctest;
-#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod keys;
 pub(crate) mod psbt;
 #[allow(missing_docs)] // TODO add missing docs and remove this allow