]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Add bindings no-export tags to doc test types
authorMatt Corallo <git@bluematt.me>
Wed, 1 May 2024 15:19:20 +0000 (15:19 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 1 May 2024 16:04:37 +0000 (16:04 +0000)
We don't actually intend these to be public as they're just for
docs but the bindings don't currently parse `#[doc(hidden)]` as
"no-export" so we add manual no-export tags as well.

lightning/src/sign/mod.rs

index 1710fe65c86c40f18f6616fcc4477526d3725dc9..1ff9db8d19886a30c3d4dff399d31e1c595c142c 100644 (file)
@@ -923,6 +923,8 @@ pub trait OutputSpender {
 
 // Primarily needed in doctests because of https://github.com/rust-lang/rust/issues/67295
 /// A dynamic [`SignerProvider`] temporarily needed for doc tests.
+///
+/// This is not exported to bindings users as it is not intended for public consumption.
 #[cfg(taproot)]
 #[doc(hidden)]
 #[deprecated(note = "Remove once taproot cfg is removed")]
@@ -930,6 +932,8 @@ pub type DynSignerProvider =
        dyn SignerProvider<EcdsaSigner = InMemorySigner, TaprootSigner = InMemorySigner>;
 
 /// A dynamic [`SignerProvider`] temporarily needed for doc tests.
+///
+/// This is not exported to bindings users as it is not intended for public consumption.
 #[cfg(not(taproot))]
 #[doc(hidden)]
 #[deprecated(note = "Remove once taproot cfg is removed")]