improve feature documentation

gbaranski · Jan 7, 2024 · c535c18 · c535c18
1 parent 14d4266
commit c535c18
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/src/client.rs b/src/client.rs
@@ -414,6 +414,7 @@ impl<E: ClientExt> Client<E> {
 /// - Requires feature `native_client`.
 /// - May only be invoked from within a tokio runtime.
 #[cfg(feature = "native_client")]
+#[cfg_attr(docsrs, doc(cfg(feature = "native_client")))]
 pub async fn connect<E: ClientExt + 'static>(
     client_fn: impl FnOnce(Client<E>) -> E,
     config: ClientConfig,

diff --git a/src/client_connectors/mod.rs b/src/client_connectors/mod.rs
@@ -1,12 +1,14 @@
 cfg_if::cfg_if! {
     if #[cfg(all(feature = "native_client", not(target_family = "wasm")))] {
+        #[cfg_attr(docsrs, doc(cfg(all(feature = "native_client", not(target_family = "wasm")))))]
         mod client_connector_tokio;
         pub use client_connector_tokio::*;
     }
 }
 
 cfg_if::cfg_if! {
     if #[cfg(all(feature = "wasm_client", target_family = "wasm"))] {
+        #[cfg_attr(docsrs, doc(cfg(all(feature = "wasm_client", target_family = "wasm"))))]
         mod client_connector_wasm;
         pub use client_connector_wasm::*;
     }

diff --git a/src/lib.rs b/src/lib.rs
@@ -5,6 +5,8 @@
 //!
 //! Refer to [`client`] or [`server`] module for detailed implementation guides.
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 mod socket;
 mod tungstenite_common;
 
@@ -21,7 +23,9 @@ pub use socket::Stream;
 
 cfg_if::cfg_if! {
     if #[cfg(feature = "client")] {
+        #[cfg_attr(docsrs, doc(cfg(feature = "client")))]
         pub mod client;
+        #[cfg_attr(docsrs, doc(cfg(feature = "client")))]
         mod client_connectors;
 
         pub use client_connectors::*;
@@ -38,10 +42,15 @@ cfg_if::cfg_if! {
 
 cfg_if::cfg_if! {
     if #[cfg(feature = "server")] {
+        #[cfg_attr(docsrs, doc(cfg(feature = "server")))]
         pub mod server;
+        #[cfg_attr(docsrs, doc(cfg(feature = "server")))]
         pub mod session;
-        mod server_runners;
+        #[cfg(any(feature = "axum", feature = "tungstenite"))]
+        #[cfg_attr(docsrs, doc(cfg(feature = "server")))]
+        pub mod server_runners;
 
+        #[cfg(any(feature = "axum", feature = "tungstenite"))]
         pub use server_runners::*;
 
         pub use server::Server;

diff --git a/src/server_runners/mod.rs b/src/server_runners/mod.rs
@@ -1,9 +1,12 @@
 cfg_if::cfg_if! {
     if #[cfg(feature = "axum")] {
+        #[cfg_attr(docsrs, doc(cfg(feature = "axum")))]
         pub mod axum;
+        #[cfg_attr(docsrs, doc(cfg(feature = "axum")))]
         pub mod axum_tungstenite;
     }
 }
 
 #[cfg(feature = "tungstenite")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tungstenite")))]
 pub mod tungstenite;
diff --git a/src/server_runners/tungstenite.rs b/src/server_runners/tungstenite.rs
@@ -49,9 +49,13 @@ use tokio::net::ToSocketAddrs;
 
 pub enum Acceptor {
     Plain,
+
     #[cfg(feature = "native-tls")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "native-tls")))]
     NativeTls(tokio_native_tls::TlsAcceptor),
+
     #[cfg(feature = "rustls")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "rustls")))]
     Rustls(tokio_rustls::TlsAcceptor),
 }