Find incomplete docs

[jortberends]

This PR adds the mind_incomplete_docs flag to the missing_docs rule to warn about incomplete documentation.

Triggering examples: Return type not documented

/// docs
public func a() -> Bool {
    return true
}

Incorrect parameter documented

/// docs
/// - Parameters:
///   - b: docs
public func a(a: Bool) {}

Parameter not documented

/// docs
public func a(a: Bool) {}

Non-triggering examples:

/// docs
/// - Parameter a: docs
public func a(a: Bool) {}

/// docs
/// - Parameters:
///   - a: docs
public func a(a: Bool) {}

/// docs
/// - Returns: docs
public func a() -> Bool {
    return true
}

[SwiftLintBot]

	7587 Warnings
:warning:	This PR introduced a violation in Aerial: /Aerial/Source/Models/Time/Solar.swift:247:27: warning: Missing Docs Violation: Parameter zenith should be documented. (missing_docs)
:warning:	This PR introduced a violation in Aerial: /Aerial/Source/Models/Time/Solar.swift:247:12: warning: Missing Docs Violation: Return type Bool should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:159:39: warning: Missing Docs Violation: Parameter acceptableStatusCodes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:173:39: warning: Missing Docs Violation: Parameter acceptableContentTypes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:173:12: warning: Missing Docs Violation: Return type Self should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:186:12: warning: Missing Docs Violation: Return type Self should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:207:39: warning: Missing Docs Violation: Parameter acceptableStatusCodes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:221:39: warning: Missing Docs Violation: Parameter acceptableContentTypes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:221:12: warning: Missing Docs Violation: Return type Self should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:260:39: warning: Missing Docs Violation: Parameter acceptableStatusCodes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:274:39: warning: Missing Docs Violation: Parameter acceptableContentTypes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:274:12: warning: Missing Docs Violation: Return type Self should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Validation.swift:296:12: warning: Missing Docs Violation: Return type Self should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/AFError.swift:222:27: warning: Missing Docs Violation: Parameter message should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/AFError.swift:222:74: warning: Missing Docs Violation: Parameter file should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/AFError.swift:222:102: warning: Missing Docs Violation: Parameter line should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/AFError.swift:222:12: warning: Missing Docs Violation: Return type AFError should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:139:33: warning: Missing Docs Violation: Parameter transform should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:139:12: warning: Missing Docs Violation: Return type DataResponse<NewSuccess, Failure> should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:162:36: warning: Missing Docs Violation: Parameter transform should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:162:12: warning: Missing Docs Violation: Return type DataResponse<NewSuccess, Error> should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:259:17: warning: Missing Docs Violation: Parameter fileURL should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:321:33: warning: Missing Docs Violation: Parameter transform should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:321:12: warning: Missing Docs Violation: Return type DownloadResponse<NewSuccess, Failure> should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:345:36: warning: Missing Docs Violation: Parameter transform should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Response.swift:345:12: warning: Missing Docs Violation: Return type DownloadResponse<NewSuccess, Error> should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/HTTPHeaders.swift:36:17: warning: Missing Docs Violation: Parameter headers should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/HTTPHeaders.swift:44:17: warning: Missing Docs Violation: Parameter dictionary should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/URLEncodedFormEncoder.swift:492:30: warning: Missing Docs Violation: Parameter value should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/URLEncodedFormEncoder.swift:492:65: warning: Missing Docs Violation: Parameter path should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Session.swift:330:46: warning: Missing Docs Violation: Parameter requestModifier should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Session.swift:802:22: warning: Missing Docs Violation: Parameter url should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:128:17: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:128:41: warning: Missing Docs Violation: Parameter queue should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:221:48: warning: Missing Docs Violation: Parameter emptyResponseMethods should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:235:37: warning: Missing Docs Violation: Parameter queue should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:591:48: warning: Missing Docs Violation: Parameter emptyResponseMethods should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:604:17: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/Combine.swift:604:45: warning: Missing Docs Violation: Parameter queue should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:38:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:38:44: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:43:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:43:44: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:43:66: warning: Missing Docs Violation: Parameter challenge should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:46:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:47:21: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:48:21: warning: Missing Docs Violation: Parameter bytesSent should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:49:21: warning: Missing Docs Violation: Parameter totalBytesSent should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:50:21: warning: Missing Docs Violation: Parameter totalBytesExpectedToSend should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:53:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:53:44: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:56:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:57:21: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:58:21: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:59:21: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:62:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:62:44: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:62:66: warning: Missing Docs Violation: Parameter metrics should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:65:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:65:44: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:65:66: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:69:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:69:44: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:74:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:74:44: warning: Missing Docs Violation: Parameter dataTask should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:74:74: warning: Missing Docs Violation: Parameter data should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:77:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:77:44: warning: Missing Docs Violation: Parameter dataTask should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:77:74: warning: Missing Docs Violation: Parameter proposedResponse should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:82:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:83:21: warning: Missing Docs Violation: Parameter downloadTask should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:84:21: warning: Missing Docs Violation: Parameter fileOffset should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:85:21: warning: Missing Docs Violation: Parameter expectedTotalBytes should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:88:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:89:21: warning: Missing Docs Violation: Parameter downloadTask should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:90:21: warning: Missing Docs Violation: Parameter bytesWritten should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:91:21: warning: Missing Docs Violation: Parameter totalBytesWritten should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:92:21: warning: Missing Docs Violation: Parameter totalBytesExpectedToWrite should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:95:21: warning: Missing Docs Violation: Parameter session should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:95:44: warning: Missing Docs Violation: Parameter downloadTask should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:95:82: warning: Missing Docs Violation: Parameter location should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:101:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:101:38: warning: Missing Docs Violation: Parameter urlRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:104:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:104:38: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:107:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:107:38: warning: Missing Docs Violation: Parameter initialRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:107:89: warning: Missing Docs Violation: Parameter adaptedRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:110:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:110:38: warning: Missing Docs Violation: Parameter initialRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:110:91: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:113:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:113:38: warning: Missing Docs Violation: Parameter urlRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:116:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:116:38: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:119:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:119:38: warning: Missing Docs Violation: Parameter metrics should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:122:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:122:38: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:122:72: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:126:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:126:38: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:126:76: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:129:28: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:132:27: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:135:27: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:138:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:138:38: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:141:28: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:144:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:144:38: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:147:27: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:150:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:150:38: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:155:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:156:18: warning: Missing Docs Violation: Parameter urlRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:157:18: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:158:18: warning: Missing Docs Violation: Parameter data should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:159:18: warning: Missing Docs Violation: Parameter result should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:162:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:162:42: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:165:25: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:165:49: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:191:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:191:44: warning: Missing Docs Violation: Parameter uploadable should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:194:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:194:44: warning: Missing Docs Violation: Parameter error should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:198:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:198:44: warning: Missing Docs Violation: Parameter stream should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:203:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:203:46: warning: Missing Docs Violation: Parameter task should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:203:94: warning: Missing Docs Violation: Parameter result should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:207:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:207:46: warning: Missing Docs Violation: Parameter url should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:210:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:211:18: warning: Missing Docs Violation: Parameter urlRequest should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:212:18: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:213:18: warning: Missing Docs Violation: Parameter fileURL should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:214:18: warning: Missing Docs Violation: Parameter result should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:217:18: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:217:46: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:220:25: warning: Missing Docs Violation: Parameter request should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/EventMonitor.swift:220:53: warning: Missing Docs Violation: Parameter response should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/ResponseSerialization.swift:79:5: warning: Missing Docs Violation: Return type Data should be documented. (missing_docs)
:warning:	This PR introduced a violation in Alamofire: /Source/ResponseSerialization.swift:941:5: warning: Missing Docs Violation: Return type SerializedObject should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/Logger.swift:58:38: warning: Missing Docs Violation: Parameter inDocuments should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/Logger.swift:58:5: warning: Missing Docs Violation: Return type String? should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/DeferredUtils.swift:55:23: warning: Missing Docs Violation: Parameter t should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/DeferredUtils.swift:55:8: warning: Missing Docs Violation: Return type () -> Deferred<Maybe<T>> should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/DeferredUtils.swift:83:21: warning: Missing Docs Violation: Parameter items should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/DeferredUtils.swift:83:35: warning: Missing Docs Violation: Parameter f should be documented. (missing_docs)
:warning:	This PR introduced a violation in Firefox: /Shared/DeferredUtils.swift:83:8: warning: Missing Docs Violation: Return type Success should be documented. (missing_docs)
:warning:	Danger found 7587 violations with this PR. Due to GitHub's max issue comment size, the number shown has been truncated to 152.

	13 Messages
:book:	Linting Aerial with this PR took 2.06s vs 2.0s on master (3% slower)
:book:	Linting Alamofire with this PR took 2.87s vs 2.85s on master (0% slower)
:book:	Linting Firefox with this PR took 9.7s vs 9.69s on master (0% slower)
:book:	Linting Kickstarter with this PR took 15.13s vs 15.24s on master (0% faster)
:book:	Linting Moya with this PR took 1.35s vs 1.49s on master (9% faster)
:book:	Linting Nimble with this PR took 1.29s vs 1.26s on master (2% slower)
:book:	Linting Quick with this PR took 0.59s vs 0.59s on master (0% slower)
:book:	Linting Realm with this PR took 4.16s vs 4.17s on master (0% faster)
:book:	Linting SourceKitten with this PR took 1.07s vs 1.04s on master (2% slower)
:book:	Linting Sourcery with this PR took 8.47s vs 8.42s on master (0% slower)
:book:	Linting Swift with this PR took 11.28s vs 11.2s on master (0% slower)
:book:	Linting WordPress with this PR took 18.2s vs 18.33s on master (0% faster)
:book:	This PR fixed a violation in Sourcery: /SourceryTests/Stub/Performance-Code/Kiosk/App/Networking/NetworkLogger.swift:13:5: warning: Inclusive Language Violation: Declaration init(whitelist:blacklist:) contains the term "whitelist" which is not considered inclusive. (inclusive_language)

Generated by :no_entry_sign: Danger

[jortberends]

Rebased.

[jpsim]

Since this rule was originally written, a new project specifically for linting and fixing Swift docstrings has appeared: https://github.com/dduan/DrString

I'm wondering if it's best to point people to use that tool instead of trying to match its feature set in SwiftLint.

[jortberends]

Hey @jpsim thanks for reaching out. We were totally unaware of the DrString project. It looks way more extensive than the rule we wrote. Will try to use your project to see if this PR still makes any sense or should be closed.

[TomVanDerSpek]

@jpsim, DrString helps you find and fix inconsistencies in your documentation. It doesn’t warn you if documentation is missing and you also cannot specify what kind of api access level you want to have documented (private / internal / public). So unfortunately DrString does not solve the same problem as this MR does at the moment.

Would be awesome if someone could look at this MR and approve it.

[bdfox325]

@jortberends What is the status of this MR. Would love to use this. It would also be great if the rule was configurable to catch missing docs on extensions as well.

[jortberends]

@bdfox325 We're using it in our project since DrString didn't fulfil all our wishes as @TomVanDerSpek stated. It won't catch missing docs on extensions since this information is not easily provided by SourceKit afaik.

Not sure how to get more attention to this MR and get it merged, i hope it helps if people ask about the status like you did 👍

[bdfox325]

@jortberends Please take a look at my related PR: https://github.com/realm/SwiftLint/pull/3701