Merge pull request #289 from realm/jp-valid-docs-fixes

jpsim · jpsim · commit ac93b706b58e · 2015-12-23T23:54:21.000-05:00
Fix false positives in ValidDocsRule
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,8 @@
 
 ##### Bug Fixes
 
-* None.
+* Fix false positives in ValidDocsRule.
+  [JP Simard](https://github.com/jpsim)
 
 ## 0.5.2: Snuggle™
 
diff --git a/Source/SwiftLintFramework/Rules/ValidDocsRule.swift b/Source/SwiftLintFramework/Rules/ValidDocsRule.swift
@@ -92,13 +92,15 @@ func superfluousOrMissingParameterDocumentation(declaration: String, substructur
         }
         return (parameter, parameter)
     }
+    let optionallyDocumentedParameterCount = labelsAndParams.filter({ $0.0 == "_" }).count
     let commentRange = NSRange(location: 0, length: comment.utf16.count)
-    let commentParameterMatches = regex("- parameter (.+):")
+    let commentParameterMatches = regex("- parameter ([^:]+)")
         .matchesInString(comment, options: [], range: commentRange)
     let commentParameters = commentParameterMatches.map { match in
         return (comment as NSString).substringWithRange(match.rangeAtIndex(1))
     }
-    if commentParameters.count != labelsAndParams.count {
+    if commentParameters.count > labelsAndParams.count ||
+        labelsAndParams.count - commentParameters.count > optionallyDocumentedParameterCount {
         return true
     }
     return !zip(commentParameters, labelsAndParams).filter {

Original file line number	Diff line number	Diff line change
`@@ -92,13 +92,15 @@ func superfluousOrMissingParameterDocumentation(declaration: String, substructur`
`92`	`92`	`}`
`93`	`93`	`return (parameter, parameter)`
`94`	`94`	`}`
	`95`	`+ let optionallyDocumentedParameterCount = labelsAndParams.filter({ $0.0 == "_" }).count`
`95`	`96`	`let commentRange = NSRange(location: 0, length: comment.utf16.count)`
`96`		`- let commentParameterMatches = regex("- parameter (.+):")`
	`97`	`+ let commentParameterMatches = regex("- parameter ([^:]+)")`
`97`	`98`	`.matchesInString(comment, options: [], range: commentRange)`
`98`	`99`	`let commentParameters = commentParameterMatches.map { match in`
`99`	`100`	`return (comment as NSString).substringWithRange(match.rangeAtIndex(1))`
`100`	`101`	`}`
`101`		`- if commentParameters.count != labelsAndParams.count {`
	`102`	`+ if commentParameters.count > labelsAndParams.count \|\|`
	`103`	`+ labelsAndParams.count - commentParameters.count > optionallyDocumentedParameterCount {`
`102`	`104`	`return true`
`103`	`105`	`}`
`104`	`106`	`return !zip(commentParameters, labelsAndParams).filter {`