fix issues with documentation

Author: apoelstra

src/confidential.rs

@@ -99,7 +99,7 @@ impl Value {
     }
 
     /// Returns the explicit inner value.
-    /// Returns [None] if [is_explicit] returns false.
+    /// Returns [None] if [Value::is_explicit] returns false.
     pub fn explicit(&self) -> Option<u64> {
         match *self {
             Value::Explicit(i) => Some(i),
@@ -108,7 +108,7 @@ impl Value {
     }
 
     /// Returns the confidential commitment in case of a confidential value.
-    /// Returns [None] if [is_confidential] returns false.
+    /// Returns [None] if [Value::is_confidential] returns false.
     pub fn commitment(&self) -> Option<PedersenCommitment> {
         match *self {
             Value::Confidential(i) => Some(i),
@@ -306,7 +306,7 @@ impl Asset {
     }
 
     /// Returns the explicit inner value.
-    /// Returns [None] if [is_explicit] returns false.
+    /// Returns [None] if [Asset::is_explicit] returns false.
     pub fn explicit(&self) -> Option<AssetId> {
         match *self {
             Asset::Explicit(i) => Some(i),
@@ -315,7 +315,7 @@ impl Asset {
     }
 
     /// Returns the confidential commitment in case of a confidential value.
-    /// Returns [None] if [is_confidential] returns false.
+    /// Returns [None] if [Asset::is_confidential] returns false.
     pub fn commitment(&self) -> Option<Generator> {
         match *self {
             Asset::Confidential(i) => Some(i),
@@ -579,7 +579,7 @@ impl Nonce {
     }
 
     /// Returns the explicit inner value.
-    /// Returns [None] if [is_explicit] returns false.
+    /// Returns [None] if [Nonce::is_explicit] returns false.
     pub fn explicit(&self) -> Option<[u8; 32]> {
         match *self {
             Nonce::Explicit(i) => Some(i),
@@ -588,7 +588,7 @@ impl Nonce {
     }
 
     /// Returns the confidential commitment in case of a confidential value.
-    /// Returns [None] if [is_confidential] returns false.
+    /// Returns [None] if [Nonce::is_confidential] returns false.
     pub fn commitment(&self) -> Option<PublicKey> {
         match *self {
             Nonce::Confidential(i) => Some(i),

src/dynafed.rs

@@ -262,7 +262,7 @@ impl Params {
         }
     }
 
-    /// Get the signblockscript. Is [None] for [Null] params.
+    /// Get the signblockscript. Is [None] for [Params::Null] params.
     pub fn signblockscript(&self) -> Option<&Script> {
         match *self {
             Params::Null => None,
@@ -271,7 +271,7 @@ impl Params {
         }
     }
 
-    /// Get the signblock_witness_limit. Is [None] for [Null] params.
+    /// Get the signblock_witness_limit. Is [None] for [Params::Null] params.
     pub fn signblock_witness_limit(&self) -> Option<u32> {
         match *self {
             Params::Null => None,
@@ -280,7 +280,7 @@ impl Params {
         }
     }
 
-    /// Get the fedpeg_program. Is [None] for non-[Full] params.
+    /// Get the fedpeg_program. Is [None] for non-[Params::Full] params.
     pub fn fedpeg_program(&self) -> Option<&bitcoin::ScriptBuf> {
         match *self {
             Params::Null => None,
@@ -289,7 +289,7 @@ impl Params {
         }
     }
 
-    /// Get the fedpegscript. Is [None] for non-[Full] params.
+    /// Get the fedpegscript. Is [None] for non-[Params::Full] params.
     pub fn fedpegscript(&self) -> Option<&Vec<u8>> {
         match *self {
             Params::Null => None,
@@ -298,7 +298,7 @@ impl Params {
         }
     }
 
-    /// Get the extension_space. Is [None] for non-[Full] params.
+    /// Get the extension_space. Is [None] for non-[Params::Full] params.
     pub fn extension_space(&self) -> Option<&Vec<Vec<u8>>> {
         match *self {
             Params::Null => None,
@@ -307,7 +307,7 @@ impl Params {
         }
     }
 
-    /// Get the elided_root. Is [None] for non-[Compact] params.
+    /// Get the elided_root. Is [None] for non-[Params::Compact] params.
     pub fn elided_root(&self) -> Option<&sha256::Midstate> {
         match *self {
             Params::Null => None,

src/opcodes.rs

@@ -196,41 +196,41 @@ pub mod all {
     pub const OP_PUSHDATA2: All = All {code: 0x4d};
     /// Read the next 4 bytes as N; push the next N bytes as an array onto the stack
     pub const OP_PUSHDATA4: All = All {code: 0x4e};
-    /// Push the array [0x81] onto the stack
+    /// Push the array `[0x81]` onto the stack
     pub const OP_PUSHNUM_NEG1: All = All {code: 0x4f};
     /// Synonym for OP_RETURN
     pub const OP_RESERVED: All = All {code: 0x50};
-    /// Push the array [0x01] onto the stack
+    /// Push the array `[0x01]` onto the stack
     pub const OP_PUSHNUM_1: All = All {code: 0x51};
-    /// Push the array [0x02] onto the stack
+    /// Push the array `[0x02]` onto the stack
     pub const OP_PUSHNUM_2: All = All {code: 0x52};
-    /// Push the array [0x03] onto the stack
+    /// Push the array `[0x03]` onto the stack
     pub const OP_PUSHNUM_3: All = All {code: 0x53};
-    /// Push the array [0x04] onto the stack
+    /// Push the array `[0x04]` onto the stack
     pub const OP_PUSHNUM_4: All = All {code: 0x54};
-    /// Push the array [0x05] onto the stack
+    /// Push the array `[0x05]` onto the stack
     pub const OP_PUSHNUM_5: All = All {code: 0x55};
-    /// Push the array [0x06] onto the stack
+    /// Push the array `[0x06]` onto the stack
     pub const OP_PUSHNUM_6: All = All {code: 0x56};
-    /// Push the array [0x07] onto the stack
+    /// Push the array `[0x07]` onto the stack
     pub const OP_PUSHNUM_7: All = All {code: 0x57};
-    /// Push the array [0x08] onto the stack
+    /// Push the array `[0x08]` onto the stack
     pub const OP_PUSHNUM_8: All = All {code: 0x58};
-    /// Push the array [0x09] onto the stack
+    /// Push the array `[0x09]` onto the stack
     pub const OP_PUSHNUM_9: All = All {code: 0x59};
-    /// Push the array [0x0a] onto the stack
+    /// Push the array `[0x0a]` onto the stack
     pub const OP_PUSHNUM_10: All = All {code: 0x5a};
-    /// Push the array [0x0b] onto the stack
+    /// Push the array `[0x0b]` onto the stack
     pub const OP_PUSHNUM_11: All = All {code: 0x5b};
-    /// Push the array [0x0c] onto the stack
+    /// Push the array `[0x0c]` onto the stack
     pub const OP_PUSHNUM_12: All = All {code: 0x5c};
-    /// Push the array [0x0d] onto the stack
+    /// Push the array `[0x0d]` onto the stack
     pub const OP_PUSHNUM_13: All = All {code: 0x5d};
-    /// Push the array [0x0e] onto the stack
+    /// Push the array `[0x0e]` onto the stack
     pub const OP_PUSHNUM_14: All = All {code: 0x5e};
-    /// Push the array [0x0f] onto the stack
+    /// Push the array `[0x0f]` onto the stack
     pub const OP_PUSHNUM_15: All = All {code: 0x5f};
-    /// Push the array [0x10] onto the stack
+    /// Push the array `[0x10]` onto the stack
     pub const OP_PUSHNUM_16: All = All {code: 0x60};
     /// Does nothing
     pub const OP_NOP: All = All {code: 0x61};
@@ -385,9 +385,9 @@ pub mod all {
     pub const OP_HASH256: All = All {code: 0xaa};
     /// Ignore this and everything preceding when deciding what to sign when signature-checking
     pub const OP_CODESEPARATOR: All = All {code: 0xab};
-    /// https://en.bitcoin.it/wiki/OP_CHECKSIG pushing 1/0 for success/failure
+    /// <https://en.bitcoin.it/wiki/OP_CHECKSIG> pushing 1/0 for success/failure
     pub const OP_CHECKSIG: All = All {code: 0xac};
-    /// https://en.bitcoin.it/wiki/OP_CHECKSIG returning success/failure
+    /// <https://en.bitcoin.it/wiki/OP_CHECKSIG> returning success/failure
     pub const OP_CHECKSIGVERIFY: All = All {code: 0xad};
     /// Pop N, N pubkeys, M, M signatures, a dummy (due to bug in reference code), and verify that all M signatures are valid.
     /// Push 1 for "all valid", 0 otherwise
@@ -396,9 +396,9 @@ pub mod all {
     pub const OP_CHECKMULTISIGVERIFY: All = All {code: 0xaf};
     /// Does nothing
     pub const OP_NOP1: All = All {code: 0xb0};
-    /// https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki
+    /// <https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki>
     pub const OP_CLTV: All = All {code: 0xb1};
-    /// https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki
+    /// <https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki>
     pub const OP_CSV: All = All {code: 0xb2};
     /// Does nothing
     pub const OP_NOP4: All = All {code: 0xb3};

src/pset/map/input.rs

@@ -222,7 +222,7 @@ pub struct Input {
     pub required_height_locktime: Option<locktime::Height>,
     /// Serialized schnorr signature with sighash type for key spend
     pub tap_key_sig: Option<schnorr::SchnorrSig>,
-    /// Map of <xonlypubkey>|<leafhash> with signature
+    /// Map of `<xonlypubkey>|<leafhash>` with signature
     #[cfg_attr(feature = "serde", serde(with = "crate::serde_utils::btreemap_as_seq"))]
     pub tap_script_sigs: BTreeMap<(XOnlyPublicKey, TapLeafHash), schnorr::SchnorrSig>,
     /// Map of Control blocks to Script version pair
@@ -292,7 +292,7 @@ impl Default for Input {
 }
 
 /// A Signature hash type for the corresponding input. As of taproot upgrade, the signature hash
-/// type can be either [`SigHashType`] or [`SchnorrSigHashType`] but it is not possible to know
+/// type can be either [`EcdsaSigHashType`] or [`SchnorrSigHashType`] but it is not possible to know
 /// directly which signature hash type the user is dealing with. Therefore, the user is responsible
 /// for converting to/from [`PsbtSighashType`] from/to the desired signature hash type they need.
 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
@@ -358,7 +358,7 @@ impl From<SchnorrSigHashType> for PsbtSighashType {
 }
 
 impl PsbtSighashType {
-    /// Returns the [`SigHashType`] if the [`PsbtSighashType`] can be
+    /// Returns the [`EcdsaSigHashType`] if the [`PsbtSighashType`] can be
     /// converted to one.
     pub fn ecdsa_hash_ty(self) -> Option<EcdsaSigHashType> {
         EcdsaSigHashType::from_standard(self.inner).ok()
@@ -376,8 +376,7 @@ impl PsbtSighashType {
 
     /// Creates a [`PsbtSighashType`] from a raw `u32`.
     ///
-    /// Allows construction of a non-standard or non-valid sighash flag
-    /// ([`SigHashType`], [`SchnorrSigHashType`] respectively).
+    /// Allows construction of a non-standard or non-valid sighash flag.
     pub fn from_u32(n: u32) -> PsbtSighashType {
         PsbtSighashType { inner: n }
     }

src/pset/mod.rs

@@ -15,10 +15,10 @@
 //! # Partially Signed Elements Transactions (PSET)
 //!
 //! Implementation of BIP174 Partially Signed Bitcoin Transaction Format as
-//! defined at https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki
+//! defined at <https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki>
 //! except we define PSETs containing non-standard SigHash types as invalid.
 //! Extension for PSET is based on PSET defined in BIP370.
-//! https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki
+//! <https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki>
 
 use std::collections::HashMap;
 use std::{cmp, io};

src/pset/raw.rs

@@ -15,7 +15,7 @@
 //! # Raw PSET Key-Value Pairs
 //!
 //! Raw PSET key-value pairs as defined at
-//! https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki.
+//! <https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki>.
 
 use std::{fmt, io};
 

src/schnorr.rs

@@ -140,7 +140,7 @@ impl TweakedPublicKey {
         TweakedPublicKey(xonly)
     }
 
-    /// Create a new [TweakedPublicKey] from a [PublicKey]. No tweak is applied.
+    /// Create a new [`TweakedPublicKey`] from a [`XOnlyPublicKey`]. No tweak is applied.
     pub fn new(key: XOnlyPublicKey) -> TweakedPublicKey {
         TweakedPublicKey(key)
     }
@@ -173,7 +173,7 @@ impl TweakedKeyPair {
         self.0
     }
 
-    /// Returns the [`TweakedPublicKey`] and its [`Parity`] for this [`TweakedKeyPair`].
+    /// Returns the [`TweakedPublicKey`] and its [`secp256k1_zkp::Parity`] for this [`TweakedKeyPair`].
     #[inline]
     pub fn public_parts(&self) -> (TweakedPublicKey, secp256k1_zkp::Parity) {
         let (xonly, parity) = self.0.x_only_public_key();

src/script.rs

@@ -448,7 +448,7 @@ impl Script {
     /// iterator will end. To instead iterate over the script as sequence of bytes, treat
     /// it as a slice using `script[..]` or convert it to a vector using `into_bytes()`.
     ///
-    /// To force minimal pushes, use [instructions_minimal].
+    /// To force minimal pushes, use [Script::instructions_minimal].
     pub fn instructions(&self) -> Instructions {
         Instructions {
             data: &self.0[..],

src/sighash.rs

@@ -468,7 +468,7 @@ impl<R: Deref<Target = Transaction>> SigHashCache<R> {
     /// Compute the BIP341 sighash for a script spend
     ///
     /// Assumes the default `OP_CODESEPARATOR` position of `0xFFFFFFFF`. Custom values can be
-    /// provided through the more fine-grained API of [`SighashCache::taproot_encode_signing_data_to`].
+    /// provided through the more fine-grained API of [`SigHashCache::taproot_encode_signing_data_to`].
     pub fn taproot_script_spend_signature_hash<S: Into<TapLeafHash>, T: Borrow<TxOut>>(
         &mut self,
         input_index: usize,

src/slip77.rs

@@ -1,7 +1,7 @@
 //! Implemenation of SLIP-0077: Deterministic blinding key derivation
 //! for Confidential Transactions
 //!
-//! Spec: https://github.com/satoshilabs/slips/blob/master/slip-0077.md
+//! Spec: <https://github.com/satoshilabs/slips/blob/master/slip-0077.md>
 
 use crate::hashes::{Hash, HashEngine, hmac, sha256, sha256d};
 use secp256k1_zkp;
@@ -35,7 +35,7 @@ impl MasterBlindingKey {
     }
 
     /// Derive a shared nonce for a given scriptPubkey and a blinding pubkey.
-    /// This is the same as performing ECDH with the secret key that [derive_blinding_key] returns.
+    /// This is the same as performing ECDH with the secret key that [MasterBlindingKey::derive_blinding_key] returns.
     pub fn derive_shared_nonce(&self,
         script_pubkey: &Script,
         other: &secp256k1_zkp::PublicKey,