docs: mark items related to Builder::authenticate2 as #[doc(hidden)]

Plus fix doc comments.
libp2p · Nov 17, 2023 · a6905ba · a6905ba
1 parent 5c5b728
commit a6905ba
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/core/src/transport/upgrade.rs b/core/src/transport/upgrade.rs
@@ -131,8 +131,9 @@ where
     /// ## Alternative state
     ///
     /// This function is an alternative code path to [`Builder::authenticate`]
-    /// given the supplied upgrade implements `SecurityUpgrade` instead of
-    /// `InboundConnectionUpgrade`/`OutboundConnectionUpgrade`.
+    /// given the supplied upgrade implements `InboundSecurityUpgrade`/`OutboundSecurityUpgrade`
+    /// instead of `InboundConnectionUpgrade`/`OutboundConnectionUpgrade`.
+    #[doc(hidden)]
     pub fn authenticate2<C, D, U, E>(
         self,
         upgrade: U,
@@ -166,6 +167,7 @@ where
 /// in the context of negotiating a secure channel.
 ///
 /// Configured through [`Builder::authenticate`].
+#[doc(hidden)]
 #[pin_project::pin_project]
 pub struct Authenticate<C, U>
 where