Skip to content

Commit

Permalink
docs: mark items related to Builder::authenticate2 as #[doc(hidden)]
Browse files Browse the repository at this point in the history
Plus fix doc comments.
  • Loading branch information
denis2glez committed Nov 17, 2023
1 parent 5c5b728 commit b686801
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions core/src/transport/upgrade.rs
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ where
/// This function is an alternative code path to [`Builder::authenticate`]
/// given the supplied upgrade implements `SecurityUpgrade` instead of
/// `InboundConnectionUpgrade`/`OutboundConnectionUpgrade`.
#[doc(hidden)]
pub fn authenticate2<C, D, U, E>(
self,
upgrade: U,
Expand Down Expand Up @@ -198,6 +199,7 @@ where
/// in the context of negotiating a secure channel.
///
/// Configured through [`Builder::authenticate2`].
#[doc(hidden)]
#[pin_project::pin_project]
pub struct Authenticate2<C, U>
where
Expand Down

0 comments on commit b686801

Please sign in to comment.