From e4a1e09a77d093116fdea7c54d1d0c4f23fe8c96 Mon Sep 17 00:00:00 2001 From: Adam Fowler Date: Wed, 6 Nov 2024 11:50:54 +0000 Subject: [PATCH] Update function header comments --- Sources/HummingbirdHTTP2/HTTP2Channel.swift | 5 +++-- Sources/HummingbirdHTTP2/HTTPServerBuilder+http2.swift | 4 +++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/Sources/HummingbirdHTTP2/HTTP2Channel.swift b/Sources/HummingbirdHTTP2/HTTP2Channel.swift index 15eff80e..3ede49b2 100644 --- 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 index df69a157..b1c174a6 100644 --- 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(