Parse single parameter items correctly

SwiftDocOrg · Mar 16, 2020 · 431f418 · 431f418
1 parent 33db1d5
commit 431f418
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/Sources/SwiftMarkup/Documentation.swift b/Sources/SwiftMarkup/Documentation.swift
@@ -266,14 +266,15 @@ extension Documentation {
 
         private func visitBulletListItem(_ node: List.Item) {
             let string = node.description
-            let pattern = #"\s*[\-\+\*]\s*(?<name>[\w\h]+):(\s*(?<description>.+))?"#
-            let regularExpression = try! NSRegularExpression(pattern: pattern, options: [.dotMatchesLineSeparators])
+            let pattern = #"\s*[\-\+\*]\s*(?<parameter>(?:Parameter\s+)?)(?<name>[\w\h]+):(\s*(?<description>.+))?"#
+            let regularExpression = try! NSRegularExpression(pattern: pattern, options: [.dotMatchesLineSeparators, .caseInsensitive])
 
             guard let match = regularExpression.firstMatch(in: string, options: [], range: NSRange(string.startIndex ..< string.endIndex, in: string)),
-                let nameRange = Range(match.range(at: 1), in: string),
-                let descriptionRange = Range(match.range(at: 2), in: string)
-                else {
-                    return
+                let parameterRange = Range(match.range(at: 1), in: string),
+                let nameRange = Range(match.range(at: 2), in: string),
+                let descriptionRange = Range(match.range(at: 3), in: string)
+            else {
+                return
             }
 
             func normalize<S: StringProtocol>(_ string: S) -> String {
@@ -291,7 +292,8 @@ extension Documentation {
             }
 
             switch state {
-            case .parameters:
+            case .parameters,
+                 _ where !parameterRange.isEmpty:
                 documentation.parameters += [(name, description)]
             case .discussion:
                 if name.caseInsensitiveCompare("parameters") == .orderedSame {

diff --git a/Tests/SwiftMarkupTests/SwiftMarkupTests.swift b/Tests/SwiftMarkupTests/SwiftMarkupTests.swift
@@ -16,8 +16,8 @@ although the words were used with some degree of overlap for a time.
 
 - Author: Mattt
 - Complexity: `O(1)`
+- Parameter style: The style of the bicycle
 - Parameters:
-   - style: The style of the bicycle
    - gearing: The gearing of the bicycle
    - handlebar: The handlebar of the bicycle
    - frameSize: The frame size of the bicycle, in centimeters