Commit f3fa4a5

authored

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

1 parent 6779786 commit f3fa4a5Copy full SHA for f3fa4a5

File tree

+13

-4

lines changed

+13

-4

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`"prioritizeKeepingFunctionOutputTogether" : false,`
`17`	`17`	`"respectsExistingLineBreaks" : true,`
`18`	`18`	`"rules" : {`
`19`		`- "AllPublicDeclarationsHaveDocumentation" : false,`
	`19`	`+ "AllPublicDeclarationsHaveDocumentation" : true,`
`20`	`20`	`"AlwaysUseLowerCamelCase" : false,`
`21`	`21`	`"AmbiguousTrailingClosureOverload" : true,`
`22`	`22`	`"BeginDocumentationCommentWithOneLineSummary" : false,`
`@@ -50,7 +50,7 @@`
`50`	`50`	`"UseSynthesizedInitializer" : true,`
`51`	`51`	`"UseTripleSlashForDocumentationComments" : true,`
`52`	`52`	`"UseWhereClausesInForLoops" : false,`
`53`		`- "ValidateDocumentationComments" : false`
	`53`	`+ "ValidateDocumentationComments" : true`
`54`	`54`	`},`
`55`	`55`	`"spacesAroundRangeFormationOperators" : false,`
`56`	`56`	`"tabWidth" : 8,`

Lines changed: 11 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -139,8 +139,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {`
`139`	`139`	`}`
`140`	`140`
`141`	`141`	`/// 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.`
`144`	`143`	`public init(configuration: Configuration) {`
`145`	`144`	`self.init(`
`146`	`145`	`configuration: configuration,`
`@@ -150,6 +149,16 @@ public struct AsyncHTTPClientTransport: ClientTransport {`
`150`	`149`
`151`	`150`	`// MARK: ClientTransport`
`152`	`151`
	`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.`
`153`	`162`	`public func send(`
`154`	`163`	`_ request: HTTPRequest,`
`155`	`164`	`body: HTTPBody?,`

Comments

(0)