docs: fix broken links etc

Remove the deprecated (well, renamed) "allow broken intradoc links" cfg
flag, which exposes a ton of broken doc links. Mostly just uses of []
or <> that aren't in backticks. Fix them all.

The one morally questionable change is to change two doclink references
to Policy::enumerate_policy_tree to no longer be doclinks. The problem
is that this function only exists when the `compiler` flag is on. In
master in ebaa31b we just removed
these references as well, but arguably we should have fixed them.

Anyway in 9.x we're certainly not going to bend over backward to fix
stuff like this.

Author: apoelstra

src/descriptor/key.rs

@@ -442,8 +442,8 @@ impl DescriptorPublicKey {
         }
     }
 
+    #[doc(hidden)]
     #[deprecated(note = "use at_derivation_index instead")]
-    /// Deprecated name of [`at_derivation_index`].
     pub fn derive(self, index: u32) -> DefiniteDescriptorKey {
         self.at_derivation_index(index)
     }

src/descriptor/mod.rs

@@ -542,8 +542,8 @@ impl Descriptor<DescriptorPublicKey> {
             .expect("BIP 32 key index substitution cannot fail")
     }
 
+    #[doc(hidden)]
     #[deprecated(note = "use at_derivation_index instead")]
-    /// Deprecated name for [`at_derivation_index`].
     pub fn derive(&self, index: u32) -> Descriptor<DefiniteDescriptorKey> {
         self.at_derivation_index(index)
     }
@@ -569,7 +569,7 @@ impl Descriptor<DescriptorPublicKey> {
     /// See [`at_derivation_index`] and `[derived_descriptor`] for more documentation.
     ///
     /// [`at_derivation_index`]: Self::at_derivation_index
-    /// [`derived_descriptor`]: crate::DerivedDescriptor::derived_descriptor
+    /// [`derived_descriptor`]: crate::Descriptor::derived_descriptor
     ///
     /// # Errors
     ///

src/lib.rs

@@ -167,7 +167,7 @@ pub trait MiniscriptKey: Clone + Eq + Ord + fmt::Debug + fmt::Display + hash::Ha
     /// The associated [`hash256::Hash`] for this [`MiniscriptKey`],
     /// used in the hash256 fragment.
     type Hash256: Clone + Eq + Ord + fmt::Display + fmt::Debug + hash::Hash;
-    /// The associated [`ripedmd160::Hash`] for this [`MiniscriptKey`] type.
+    /// The associated [`ripemd160::Hash`] for this [`MiniscriptKey`] type.
     /// used in the ripemd160 fragment
     type Ripemd160: Clone + Eq + Ord + fmt::Display + fmt::Debug + hash::Hash;
 

src/miniscript/decode.rs

@@ -124,7 +124,6 @@ enum NonTerm {
 /// The average user should always use the [`crate::Descriptor`] APIs. Advanced users
 /// who want deal with Miniscript ASTs should use the [`crate::Miniscript`] APIs.
 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[allow(broken_intra_doc_links)]
 pub enum Terminal<Pk: MiniscriptKey, Ctx: ScriptContext> {
     /// `1`
     True,
@@ -164,38 +163,38 @@ pub enum Terminal<Pk: MiniscriptKey, Ctx: ScriptContext> {
     Check(Arc<Miniscript<Pk, Ctx>>),
     /// `DUP IF [V] ENDIF`
     DupIf(Arc<Miniscript<Pk, Ctx>>),
-    /// [T] VERIFY
+    /// `[T] VERIFY`
     Verify(Arc<Miniscript<Pk, Ctx>>),
-    /// SIZE 0NOTEQUAL IF [Fn] ENDIF
+    /// `SIZE 0NOTEQUAL IF [Fn] ENDIF`
     NonZero(Arc<Miniscript<Pk, Ctx>>),
-    /// [X] 0NOTEQUAL
+    /// `[X] 0NOTEQUAL`
     ZeroNotEqual(Arc<Miniscript<Pk, Ctx>>),
     // Conjunctions
-    /// [V] [T]/[V]/[F]/[Kt]
+    /// `[V] [T]/[V]/[F]/[Kt]`
     AndV(Arc<Miniscript<Pk, Ctx>>, Arc<Miniscript<Pk, Ctx>>),
-    /// [E] [W] BOOLAND
+    /// `[E] [W] BOOLAND`
     AndB(Arc<Miniscript<Pk, Ctx>>, Arc<Miniscript<Pk, Ctx>>),
-    /// [various] NOTIF [various] ELSE [various] ENDIF
+    /// `[various] NOTIF [various] ELSE [various] ENDIF`
     AndOr(
         Arc<Miniscript<Pk, Ctx>>,
         Arc<Miniscript<Pk, Ctx>>,
         Arc<Miniscript<Pk, Ctx>>,
     ),
     // Disjunctions
-    /// [E] [W] BOOLOR
+    /// `[E] [W] BOOLOR`
     OrB(Arc<Miniscript<Pk, Ctx>>, Arc<Miniscript<Pk, Ctx>>),
-    /// [E] IFDUP NOTIF [T]/[E] ENDIF
+    /// `[E] IFDUP NOTIF [T]/[E] ENDIF`
     OrD(Arc<Miniscript<Pk, Ctx>>, Arc<Miniscript<Pk, Ctx>>),
-    /// [E] NOTIF [V] ENDIF
+    /// `[E] NOTIF [V] ENDIF`
     OrC(Arc<Miniscript<Pk, Ctx>>, Arc<Miniscript<Pk, Ctx>>),
-    /// IF [various] ELSE [various] ENDIF
+    /// `IF [various] ELSE [various] ENDIF`
     OrI(Arc<Miniscript<Pk, Ctx>>, Arc<Miniscript<Pk, Ctx>>),
     // Thresholds
-    /// [E] ([W] ADD)* k EQUAL
+    /// `[E] ([W] ADD)* k EQUAL`
     Thresh(usize, Vec<Arc<Miniscript<Pk, Ctx>>>),
-    /// k (<key>)* n CHECKMULTISIG
+    /// `k (<key>)* n CHECKMULTISIG`
     Multi(usize, Vec<Pk>),
-    /// <key> CHECKSIG (<key> CHECKSIGADD)*(n-1) k NUMEQUAL
+    /// `<key> CHECKSIG (<key> CHECKSIGADD)*(n-1) k NUMEQUAL`
     MultiA(usize, Vec<Pk>),
 }
 

src/policy/concrete.rs

@@ -228,7 +228,7 @@ pub enum DescriptorCtx<Pk> {
     Wsh,
     /// Sh-wrapped [Wsh][`Descriptor::Wsh`]
     ShWsh,
-    /// [Tr][`Descriptor::Tr`] where the Option<Pk> corresponds to the internal_key if no internal
+    /// [Tr][`Descriptor::Tr`] where the `Option<Pk>` corresponds to the internal_key if no internal
     /// key can be inferred from the given policy
     Tr(Option<Pk>),
 }
@@ -427,7 +427,7 @@ impl<Pk: MiniscriptKey> Policy<Pk> {
     }
 
     /// Compile the [`Policy`] into a [`Tr`][`Descriptor::Tr`] Descriptor, with policy-enumeration
-    /// by [`Policy::enumerate_policy_tree`].
+    /// by `Policy::enumerate_policy_tree`.
     ///
     /// ### TapTree compilation
     ///
@@ -439,7 +439,7 @@ impl<Pk: MiniscriptKey> Policy<Pk> {
     ///
     /// ### Policy enumeration
     ///
-    /// Refer to [`Policy::enumerate_policy_tree`] for the current strategy implemented.
+    /// Refer to `Policy::enumerate_policy_tree` for the current strategy implemented.
     #[cfg(feature = "compiler")]
     pub fn compile_tr_private_experimental(
         &self,

src/psbt/mod.rs

@@ -594,7 +594,7 @@ pub trait PsbtExt {
 
     /// Get the sighash message(data to sign) at input index `idx` based on the sighash
     /// flag specified in the [`Psbt`] sighash field. If the input sighash flag psbt field is `None`
-    /// the [`SchnorrSighashType::Default`](bitcoin::util::sighash::SchnorrSighashType::Default) is chosen
+    /// the [`SchnorrSighashType::Default`] is chosen
     /// for for taproot spends, otherwise [`EcdsaSignatureHashType::All`](bitcoin::EcdsaSighashType::All) is chosen.
     /// If the utxo at `idx` is a taproot output, returns a [`PsbtSighashMsg::TapSighash`] variant.
     /// If the utxo at `idx` is a pre-taproot output, returns a [`PsbtSighashMsg::EcdsaSighash`] variant.