update docs of some generic type parameter (#288)

minghuaw · Oct 3, 2024 · a6e1118 · a6e1118
1 parent 3485cfc
commit a6e1118
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/fe2o3-amqp/src/connection/mod.rs b/fe2o3-amqp/src/connection/mod.rs
@@ -56,6 +56,10 @@ type SessionRelay = Arc<Sender<SessionIncomingItem>>;
 /// A handle to the [`Connection`] event loop.
 ///
 /// Dropping the handle will also stop the [`Connection`] event loop.
+///
+/// # Generic Parameters
+///
+/// - `R`: The type of the session listener. This will be `()` on the client side.
 #[allow(dead_code)]
 pub struct ConnectionHandle<R> {
     /// Only change this value in `on_close` method

diff --git a/fe2o3-amqp/src/link/mod.rs b/fe2o3-amqp/src/link/mod.rs
@@ -117,12 +117,6 @@ pub mod role {
     }
 }
 
-// pub(crate) struct Transferable {
-//     input_handle: InputHandle,
-//     transfer: Transfer,
-//     payload: Payload,
-// }
-
 pub(crate) enum SenderAttachExchange {
     Complete,
     IncompleteUnsettled(Vec<(DeliveryTag, ResumingDelivery)>),

diff --git a/fe2o3-amqp/src/session/mod.rs b/fe2o3-amqp/src/session/mod.rs
@@ -54,6 +54,10 @@ pub const DEFAULT_WINDOW: Uint = 2048;
 /// A handle to the [`Session`] event loop
 ///
 /// Dropping the handle will also stop the [`Session`] event loop
+///
+/// # Generic Parameters
+///
+/// - `R`: The type of the listener for the link. This will be `()` on the client side.
 #[allow(dead_code)]
 pub struct SessionHandle<R> {
     /// This value should only be changed in the `on_end` method