Add missing docs

Author: rklaehn

src/lib.rs

@@ -71,15 +71,10 @@
 //!
 //! # History
 //!
-//! This crate evolved out of the [quic-rpc] crate, which is a generic RPC
+//! This crate evolved out of the [quic-rpc](https://docs.rs/quic-rpc/latest/quic-rpc/index.html) crate, which is a generic RPC
 //! framework for any transport with cheap streams such as QUIC. Compared to
 //! quic-rpc, this crate does not abstract over the stream type and is focused
-//! on [iroh](https://docs.rs/iroh/latest/iroh/index.html) and our [iroh quinn fork].
-//!
-//! - [quic-rpc](https://docs.rs/quic-rpc/latest/quic-rpc/index.html)
-//! - [quinn](https://docs.rs/quinn/latest/quinn/index.html)
-//! - [bytes](https://docs.rs/bytes/latest/bytes/index.html)
-//! - [iroh quinn fork](https://docs.rs/iroh-quinn/latest/iroh-quinn/index.html)
+//! on [iroh](https://docs.rs/iroh/latest/iroh/index.html) and our [iroh quinn fork](https://docs.rs/iroh-quinn/latest/iroh-quinn/index.html).
 #![cfg_attr(quicrpc_docsrs, feature(doc_cfg))]
 use std::{fmt::Debug, future::Future, io, marker::PhantomData, ops::Deref};
 

src/util.rs

@@ -10,7 +10,7 @@ mod quinn_setup_utils {
     use anyhow::Result;
     use quinn::{crypto::rustls::QuicClientConfig, ClientConfig, ServerConfig};
 
-    /// Builds default quinn client config and trusts given certificates.
+    /// Create a quinn client config and trusts given certificates.
     ///
     /// ## Args
     ///
@@ -52,6 +52,7 @@ mod quinn_setup_utils {
         Ok((server_config, cert_der.to_vec()))
     }
 
+    /// Create a quinn client config and trust all certificates.
     pub fn configure_client_insecure() -> Result<ClientConfig> {
         let crypto = rustls::ClientConfig::builder()
             .dangerous()
@@ -85,16 +86,7 @@ mod quinn_setup_utils {
             Ok(endpoint)
         }
 
-        /// Create a server endpoint with a self-signed certificate
-        ///
-        /// Returns the server endpoint and the certificate in DER format
-        pub fn make_server_endpoint(bind_addr: SocketAddr) -> Result<(Endpoint, Vec<u8>)> {
-            let (server_config, server_cert) = configure_server()?;
-            let endpoint = Endpoint::server(server_config, bind_addr)?;
-            Ok((endpoint, server_cert))
-        }
-
-        /// Constructs a QUIC endpoint that trusts all certificates.
+        /// Constructs a QUIC endpoint configured for use a client only that trusts all certificates.
         ///
         /// This is useful for testing and local connections, but should be used with care.
         pub fn make_insecure_client_endpoint(bind_addr: SocketAddr) -> Result<Endpoint> {
@@ -103,6 +95,15 @@ mod quinn_setup_utils {
             endpoint.set_default_client_config(client_cfg);
             Ok(endpoint)
         }
+
+        /// Constructs a QUIC server endpoint with a self-signed certificate
+        ///
+        /// Returns the server endpoint and the certificate in DER format
+        pub fn make_server_endpoint(bind_addr: SocketAddr) -> Result<(Endpoint, Vec<u8>)> {
+            let (server_config, server_cert) = configure_server()?;
+            let endpoint = Endpoint::server(server_config, bind_addr)?;
+            Ok((endpoint, server_cert))
+        }
     }
 
     #[cfg(not(target_arch = "wasm32"))]