Documentation comments

hummingbird-project · Apr 5, 2024 · bff34ca · bff34ca
1 parent 288282b
commit bff34ca
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/Sources/HummingbirdWebSocket/Client/WebSocketClientConfiguration.swift b/Sources/HummingbirdWebSocket/Client/WebSocketClientConfiguration.swift
@@ -14,6 +14,7 @@
 
 import HTTPTypes
 
+/// Configuration for a client connecting to a WebSocket
 public struct WebSocketClientConfiguration: Sendable {
     /// Max websocket frame size that can be sent/received
     public var maxFrameSize: Int

diff --git a/Sources/HummingbirdWebSocket/Client/WebSocketClientError.swift b/Sources/HummingbirdWebSocket/Client/WebSocketClientError.swift
@@ -12,6 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+/// Errors returned by ``WebSocketClient``
 public struct WebSocketClientError: Swift.Error, Equatable {
     private enum _Internal: Equatable {
         case invalidURL