Add feature flag docs

LLFourn · Nov 24, 2022 · 147896a · 147896a
1 parent 5c01ec4
commit 147896a
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 2 deletions.
diff --git a/ecdsa_fun/src/adaptor/encrypted_signature.rs b/ecdsa_fun/src/adaptor/encrypted_signature.rs
@@ -31,9 +31,10 @@ secp256kfun::impl_display_debug_serialize! {
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(
     feature = "serde",
-    derive(crate::serde::Deserialize, crate::serde::Serialize)
+    derive(crate::serde::Deserialize, crate::serde::Serialize),
+    serde(crate = "crate::serde")
 )]
-#[serde(crate = "crate::serde")]
+#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
 pub(crate) struct EncryptedSignatureInternal {
     pub R: PointNonce,
     pub R_hat: Point,

diff --git a/ecdsa_fun/src/lib.rs b/ecdsa_fun/src/lib.rs
@@ -13,6 +13,7 @@ extern crate std;
 mod libsecp_compat;
 
 #[cfg(feature = "serde")]
+/// Rexport `serde`
 pub use fun::serde;
 
 use fun::{
@@ -26,6 +27,7 @@ pub use secp256kfun::nonce;
 mod signature;
 pub use signature::Signature;
 #[cfg(feature = "adaptor")]
+#[cfg_attr(docsrs, doc(cfg(feature = "adaptor")))]
 pub mod adaptor;
 
 /// An instance of the ECDSA signature scheme.

diff --git a/schnorr_fun/src/adaptor/encrypted_signature.rs b/schnorr_fun/src/adaptor/encrypted_signature.rs
@@ -10,6 +10,7 @@ use secp256kfun::{marker::*, Point, Scalar};
     derive(crate::serde::Deserialize, crate::serde::Serialize),
     serde(crate = "crate::serde")
 )]
+#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
 pub struct EncryptedSignature<S = Public> {
     /// The `R` point in the signature
     pub R: Point<EvenY, Public>,

diff --git a/secp256kfun/Cargo.toml b/secp256kfun/Cargo.toml
@@ -58,3 +58,4 @@ harness = false
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/secp256kfun/src/lib.rs b/secp256kfun/src/lib.rs
@@ -41,13 +41,18 @@ pub use slice::Slice;
 
 #[cfg(feature = "secp256k1")]
 pub extern crate secp256k1;
+
+/// Re-export `serde`
+#[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
 #[cfg(feature = "serde")]
 pub use serde;
+
 #[cfg(feature = "libsecp_compat")]
 mod libsecp_compat;
 #[cfg(any(feature = "proptest", test))]
 mod proptest_impls;
 #[cfg(feature = "proptest")]
+#[cfg_attr(docsrs, doc(cfg(feature = "proptest")))]
 pub extern crate proptest;
 /// The main basepoint for secp256k1 as specified in [_SEC 2: Recommended Elliptic Curve Domain Parameters_] and used in Bitcoin.
 ///

diff --git a/secp256kfun/src/macros.rs b/secp256kfun/src/macros.rs
@@ -420,6 +420,7 @@ macro_rules! impl_debug {
 macro_rules! impl_display_serialize {
     (fn to_bytes$(<$($tpl:ident  $(: $tcl:ident)?),*>)?($self:ident : &$type:path) -> $(&)?[u8;$len:literal] $block:block) => {
         #[cfg(feature = "serde")]
+        #[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
         impl$(<$($tpl $(:$tcl)?),*>)? $crate::serde::Serialize for $type {
             fn serialize<Ser: $crate::serde::Serializer>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error> {
                 use $crate::serde::ser::SerializeTuple;
@@ -505,6 +506,7 @@ macro_rules! impl_fromstr_deserialize {
         }
 
         #[cfg(feature = "serde")]
+        #[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
         impl<'de, $($($tpl $(: $tcl)?),*)?> $crate::serde::Deserialize<'de> for $type  {
             fn deserialize<Deser: $crate::serde::Deserializer<'de>>(
                 deserializer: Deser,

diff --git a/sigma_fun/src/lib.rs b/sigma_fun/src/lib.rs
@@ -21,9 +21,11 @@ extern crate std;
 extern crate alloc;
 
 #[cfg(feature = "secp256k1")]
+#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 pub mod secp256k1;
 
 #[cfg(feature = "ed25519")]
+#[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
 pub mod ed25519;
 
 mod and;
@@ -34,13 +36,15 @@ pub use eq::Eq;
 #[cfg(feature = "alloc")]
 mod eq_all;
 #[cfg(feature = "alloc")]
+#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub use eq_all::EqAll;
 mod or;
 pub use or::*;
 
 #[cfg(feature = "alloc")]
 mod all;
 #[cfg(feature = "alloc")]
+#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub use all::All;
 pub mod ext;
 mod transcript;