swift-server/swift-openapi-async-http-client
1
0
Fork 0
mirror of https://github.com/swift-server/swift-openapi-async-http-client.git synced 2026-05-03 07:42:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enable documentation comment validation in swift-format (#21)

Browse Source
This commit is contained in:
PARAIPAN SORIN
2023-10-24 00:05:38 +03:00
committed by GitHub
parent 6779786e54
commit f3fa4a5008
2 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.swift-format
+2 -2
View File
@@ -16,7 +16,7 @@
"prioritizeKeepingFunctionOutputTogether" : false,
"respectsExistingLineBreaks" : true,
"rules" : {
"AllPublicDeclarationsHaveDocumentation" : false,
"AllPublicDeclarationsHaveDocumentation" : true,
"AlwaysUseLowerCamelCase" : false,
"AmbiguousTrailingClosureOverload" : true,
"BeginDocumentationCommentWithOneLineSummary" : false,
@@ -50,7 +50,7 @@
"UseSynthesizedInitializer" : true,
"UseTripleSlashForDocumentationComments" : true,
"UseWhereClausesInForLoops" : false,
"ValidateDocumentationComments" : false
"ValidateDocumentationComments" : true
},
"spacesAroundRangeFormationOperators" : false,
"tabWidth" : 8,
Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift
+11 -2
View File
@@ -139,8 +139,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {
}
/// Creates a new transport.
/// - Parameters:
/// - configuration: A set of configuration values used by the transport.
/// - Parameter configuration: A set of configuration values used by the transport.
public init(configuration: Configuration) {
self.init(
configuration: configuration,
@@ -150,6 +149,16 @@ public struct AsyncHTTPClientTransport: ClientTransport {
// MARK: ClientTransport
/// Sends an HTTP request and returns the corresponding HTTP response.
///
/// - Parameters:
/// - request: The HTTP request to send.
/// - body: The HTTP body to include in the request (optional).
/// - baseURL: The base URL for the request.
/// - operationID: The identifier for the operation.
///
/// - Returns: A tuple containing the HTTP response and an optional HTTP body in the response.
/// - Throws: An error if the request or response handling encounters any issues.
public func send(
_ request: HTTPRequest,
body: HTTPBody?,