Merge pull request #86 from ava-labs/docsrs

Add docsrs annotations

Author: richardpringle

src/codec/serde/mod.rs

@@ -8,7 +8,9 @@ pub mod ip_port;
 pub mod rfc_3339;
 
 #[cfg(feature = "codec_base64")]
+#[cfg_attr(docsrs, doc(cfg(feature = "codec_base64")))]
 pub mod base64_bytes;
 
 #[cfg(feature = "codec_big_int")]
+#[cfg_attr(docsrs, doc(cfg(feature = "codec_big_int")))]
 pub mod hex_0x_big_int;

src/jsonrpc/mod.rs

@@ -7,6 +7,7 @@ pub mod info;
 pub mod platformvm;
 
 #[cfg(feature = "jsonrpc_client")]
+#[cfg_attr(docsrs, doc(cfg(feature = "jsonrpc_client")))]
 pub mod client;
 
 use std::{

src/key/secp256k1/kms/mod.rs

@@ -1,2 +1,3 @@
 #[cfg(feature = "kms_aws")]
+#[cfg_attr(docsrs, doc(cfg(feature = "kms_aws")))]
 pub mod aws;

src/key/secp256k1/mod.rs

@@ -7,9 +7,11 @@ pub mod signature;
 pub mod txs;
 
 #[cfg(feature = "libsecp256k1")]
+#[cfg_attr(docsrs, doc(cfg(feature = "libsecp256k1")))]
 pub mod libsecp256k1;
 
 #[cfg(feature = "mnemonic")]
+#[cfg_attr(docsrs, doc(cfg(feature = "mnemonic")))]
 pub mod mnemonic;
 
 use std::{

src/key/secp256k1/private_key.rs

@@ -237,6 +237,7 @@ impl Key {
 
     /// Derives the private key that uses libsecp256k1.
     #[cfg(feature = "libsecp256k1")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "libsecp256k1")))]
     pub fn to_libsecp256k1(&self) -> Result<crate::key::secp256k1::libsecp256k1::PrivateKey> {
         let b = self.to_bytes();
         crate::key::secp256k1::libsecp256k1::PrivateKey::from_bytes(&b)

src/lib.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 pub mod avm;
 pub mod choices;
 pub mod codec;
@@ -17,28 +19,37 @@ pub mod utils;
 pub mod verify;
 
 #[cfg(feature = "avalanchego")]
+#[cfg_attr(docsrs, doc(cfg(feature = "avalanchego")))]
 pub mod avalanchego;
 
 #[cfg(feature = "avalanchego")]
+#[cfg_attr(docsrs, doc(cfg(feature = "avalanchego")))]
 pub mod coreth;
 
 #[cfg(feature = "subnet_evm")]
+#[cfg_attr(docsrs, doc(cfg(feature = "subnet_evm")))]
 pub mod subnet_evm;
 
 #[cfg(feature = "xsvm")]
+#[cfg_attr(docsrs, doc(cfg(feature = "xsvm")))]
 pub mod xsvm;
 
 #[cfg(feature = "evm")]
+#[cfg_attr(docsrs, doc(cfg(feature = "evm")))]
 pub mod evm;
 
 #[cfg(feature = "message")]
+#[cfg_attr(docsrs, doc(cfg(feature = "message")))]
 pub mod message;
 
 #[cfg(feature = "wallet")]
+#[cfg_attr(docsrs, doc(cfg(feature = "wallet")))]
 pub mod wallet;
 
 #[cfg(feature = "proto")]
+#[cfg_attr(docsrs, doc(cfg(feature = "proto")))]
 pub mod proto;
 
-#[cfg(any(doc, feature = "subnet"))]
+#[cfg(feature = "subnet")]
+#[cfg_attr(docsrs, doc(cfg(feature = "subnet")))]
 pub mod subnet;

src/subnet/rpc/vm/server.rs

@@ -45,6 +45,7 @@ pub struct Server<V> {
     pub vm: Arc<RwLock<V>>,
 
     #[cfg(feature = "subnet_metrics")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "subnet_metrics")))]
     /// Subnet Prometheus process metrics.
     pub process_metrics: Arc<RwLock<prometheus::Registry>>,
 
@@ -57,6 +58,7 @@ impl<V: ChainVm> Server<V> {
         Self {
             vm: Arc::new(RwLock::new(vm)),
             #[cfg(feature = "subnet_metrics")]
+            #[cfg_attr(docsrs, doc(cfg(feature = "subnet_metrics")))]
             process_metrics: Arc::new(RwLock::new(prometheus::default_registry().to_owned())),
             stop_ch,
         }
@@ -710,6 +712,7 @@ where
     }
 
     #[cfg(feature = "subnet_metrics")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "subnet_metrics")))]
     async fn gather(
         &self,
         _req: Request<Empty>,

src/wallet/mod.rs

@@ -2,6 +2,7 @@ pub mod p;
 pub mod x;
 
 #[cfg(feature = "wallet_evm")]
+#[cfg_attr(docsrs, doc(cfg(feature = "wallet_evm")))]
 pub mod evm;
 
 use std::{