Update function header comments

hummingbird-project · Nov 6, 2024 · e4a1e09 · e4a1e09
1 parent 60f2b79
commit e4a1e09
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/Sources/HummingbirdHTTP2/HTTP2Channel.swift b/Sources/HummingbirdHTTP2/HTTP2Channel.swift
@@ -70,7 +70,8 @@ public struct HTTP2UpgradeChannel: ServerChildChannel {
     ///  Initialize HTTP2Channel
     /// - Parameters:
     ///   - tlsConfiguration: TLS configuration
-    ///   - additionalChannelHandlers: Additional channel handlers to add to channel pipeline
+    ///   - additionalChannelHandlers: Additional channel handlers to add to stream channel pipeline after HTTP part decoding and
+    ///       before HTTP request handling
     ///   - responder: Function returning a HTTP response for a HTTP request
     @available(*, deprecated, renamed: "HTTP1Channel(tlsConfiguration:configuration:responder:)")
     public init(
@@ -95,7 +96,7 @@ public struct HTTP2UpgradeChannel: ServerChildChannel {
     ///  Initialize HTTP2Channel
     /// - Parameters:
     ///   - tlsConfiguration: TLS configuration
-    ///   - additionalChannelHandlers: Additional channel handlers to add to channel pipeline
+    ///   - configuration: HTTP2 channel configuration
     ///   - responder: Function returning a HTTP response for a HTTP request
     public init(
         tlsConfiguration: TLSConfiguration,

diff --git a/Sources/HummingbirdHTTP2/HTTPServerBuilder+http2.swift b/Sources/HummingbirdHTTP2/HTTPServerBuilder+http2.swift
@@ -28,7 +28,8 @@ extension HTTPServerBuilder {
     /// ```
     /// - Parameters:
     ///   - tlsConfiguration: TLS configuration
-    ///   - additionalChannelHandlers: Additional channel handlers to call before handling HTTP
+    ///   - additionalChannelHandlers: Additional channel handlers to add to stream channel pipeline after HTTP part decoding and
+    ///       before HTTP request handling
     /// - Returns: HTTPChannelHandler builder
     @available(*, deprecated, renamed: "http2Upgrade(tlsConfiguration:configuration:)")
     public static func http2Upgrade(
@@ -54,6 +55,7 @@ extension HTTPServerBuilder {
     /// )
     /// ```
     /// - Parameters:
+    ///   - tlsConfiguration: TLS configuration
     ///   - configuration: HTTP2 Upgrade channel configuration
     /// - Returns: HTTPChannelHandler builder
     public static func http2Upgrade(