Skip to content

Commit f3fa4a5

Browse files
authored
Enable documentation comment validation in swift-format (#21)
1 parent 6779786 commit f3fa4a5

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

.swift-format

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"prioritizeKeepingFunctionOutputTogether" : false,
1717
"respectsExistingLineBreaks" : true,
1818
"rules" : {
19-
"AllPublicDeclarationsHaveDocumentation" : false,
19+
"AllPublicDeclarationsHaveDocumentation" : true,
2020
"AlwaysUseLowerCamelCase" : false,
2121
"AmbiguousTrailingClosureOverload" : true,
2222
"BeginDocumentationCommentWithOneLineSummary" : false,
@@ -50,7 +50,7 @@
5050
"UseSynthesizedInitializer" : true,
5151
"UseTripleSlashForDocumentationComments" : true,
5252
"UseWhereClausesInForLoops" : false,
53-
"ValidateDocumentationComments" : false
53+
"ValidateDocumentationComments" : true
5454
},
5555
"spacesAroundRangeFormationOperators" : false,
5656
"tabWidth" : 8,

Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift

+11-2
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {
139139
}
140140

141141
/// Creates a new transport.
142-
/// - Parameters:
143-
/// - configuration: A set of configuration values used by the transport.
142+
/// - Parameter configuration: A set of configuration values used by the transport.
144143
public init(configuration: Configuration) {
145144
self.init(
146145
configuration: configuration,
@@ -150,6 +149,16 @@ public struct AsyncHTTPClientTransport: ClientTransport {
150149

151150
// MARK: ClientTransport
152151

152+
/// Sends an HTTP request and returns the corresponding HTTP response.
153+
///
154+
/// - Parameters:
155+
/// - request: The HTTP request to send.
156+
/// - body: The HTTP body to include in the request (optional).
157+
/// - baseURL: The base URL for the request.
158+
/// - operationID: The identifier for the operation.
159+
///
160+
/// - Returns: A tuple containing the HTTP response and an optional HTTP body in the response.
161+
/// - Throws: An error if the request or response handling encounters any issues.
153162
public func send(
154163
_ request: HTTPRequest,
155164
body: HTTPBody?,

0 commit comments

Comments
 (0)