review: rename DoxygenParam -> DoxygenParameter

Author: QuietMisdreavus

Sources/Markdown/Base/Markup.swift

@@ -72,7 +72,7 @@ func makeMarkup(_ data: _MarkupData) -> Markup {
     case .inlineAttributes:
         return InlineAttributes(data)
     case .doxygenParam:
-        return DoxygenParam(data)
+        return DoxygenParameter(data)
     case .doxygenReturns:
         return DoxygenReturns(data)
     }

Sources/Markdown/Block Nodes/Block Container Blocks/Doxygen Commands/DoxygenParam.swift renamed to Sources/Markdown/Block Nodes/Block Container Blocks/Doxygen Commands/DoxygenParameter.swift

@@ -22,7 +22,7 @@ import Foundation
 /// For more information about transformation matrices, refer to the Transformation
 /// documentation.
 /// ```
-public struct DoxygenParam: BlockContainer {
+public struct DoxygenParameter: BlockContainer {
     public var _data: _MarkupData
 
     init(_ raw: RawMarkup) throws {
@@ -38,11 +38,11 @@ public struct DoxygenParam: BlockContainer {
     }
 
     public func accept<V: MarkupVisitor>(_ visitor: inout V) -> V.Result {
-        return visitor.visitDoxygenParam(self)
+        return visitor.visitDoxygenParameter(self)
     }
 }
 
-public extension DoxygenParam {
+public extension DoxygenParameter {
     /// Create a new Doxygen parameter definition.
     ///
     /// - Parameter name: The name of the parameter being described.

Sources/Markdown/Visitor/MarkupVisitor.swift

@@ -281,7 +281,7 @@ public protocol MarkupVisitor {
      - parameter doxygenParam: A `DoxygenParam` element.
      - returns: The result of the visit.
      */
-    mutating func visitDoxygenParam(_ doxygenParam: DoxygenParam) -> Result
+    mutating func visitDoxygenParameter(_ doxygenParam: DoxygenParameter) -> Result
 
     /**
      Visit a `DoxygenReturns` element and return the result.
@@ -389,7 +389,7 @@ extension MarkupVisitor {
     public mutating func visitInlineAttributes(_ attributes: InlineAttributes) -> Result {
         return defaultVisit(attributes)
     }
-    public mutating func visitDoxygenParam(_ doxygenParam: DoxygenParam) -> Result {
+    public mutating func visitDoxygenParameter(_ doxygenParam: DoxygenParameter) -> Result {
         return defaultVisit(doxygenParam)
     }
     public mutating func visitDoxygenReturns(_ doxygenReturns: DoxygenReturns) -> Result {

Sources/Markdown/Walker/Walkers/MarkupTreeDumper.swift

@@ -287,7 +287,7 @@ struct MarkupTreeDumper: MarkupWalker {
         dump(attributes, customDescription: "attributes: `\(attributes.attributes)`")
     }
 
-    mutating func visitDoxygenParam(_ doxygenParam: DoxygenParam) -> () {
+    mutating func visitDoxygenParameter(_ doxygenParam: DoxygenParameter) -> () {
         dump(doxygenParam, customDescription: "parameter: \(doxygenParam.name)")
     }
 }

Tests/MarkdownTests/Parsing/DoxygenCommandParserTests.swift

@@ -20,12 +20,12 @@ class DoxygenCommandParserTests: XCTestCase {
         """
 
         let document = Document(parsing: source, options: parseOptions)
-        let param = try XCTUnwrap(document.child(at: 0) as? DoxygenParam)
+        let param = try XCTUnwrap(document.child(at: 0) as? DoxygenParameter)
         XCTAssertEqual(param.name, "thing")
 
         let expectedDump = """
         Document
-        └─ DoxygenParam parameter: thing
+        └─ DoxygenParameter parameter: thing
            └─ Paragraph
               └─ Text "The thing."
         """
@@ -60,12 +60,12 @@ class DoxygenCommandParserTests: XCTestCase {
         """#
 
         let document = Document(parsing: source, options: parseOptions)
-        let param = try XCTUnwrap(document.child(at: 0) as? DoxygenParam)
+        let param = try XCTUnwrap(document.child(at: 0) as? DoxygenParameter)
         XCTAssertEqual(param.name, "thing")
 
         let expectedDump = """
         Document
-        └─ DoxygenParam parameter: thing
+        └─ DoxygenParameter parameter: thing
            └─ Paragraph
               └─ Text "The thing."
         """
@@ -82,7 +82,7 @@ class DoxygenCommandParserTests: XCTestCase {
 
         let expectedDump = """
         Document
-        └─ DoxygenParam parameter: thing
+        └─ DoxygenParameter parameter: thing
            └─ Paragraph
               ├─ Text "The thing."
               ├─ SoftBreak
@@ -102,7 +102,7 @@ class DoxygenCommandParserTests: XCTestCase {
 
         let expectedDump = """
         Document
-        ├─ DoxygenParam parameter: thing
+        ├─ DoxygenParameter parameter: thing
         │  └─ Paragraph
         │     └─ Text "The thing."
         └─ Paragraph
@@ -125,10 +125,10 @@ class DoxygenCommandParserTests: XCTestCase {
         Document
         ├─ Paragraph
         │  └─ Text "Messes with the thing."
-        ├─ DoxygenParam parameter: thing
+        ├─ DoxygenParameter parameter: thing
         │  └─ Paragraph
         │     └─ Text "The thing."
-        └─ DoxygenParam parameter: otherThing
+        └─ DoxygenParameter parameter: otherThing
            └─ Paragraph
               └─ Text "The other thing."
         """
@@ -151,7 +151,7 @@ class DoxygenCommandParserTests: XCTestCase {
         Document
         ├─ Paragraph
         │  └─ Text "Messes with the thing."
-        ├─ DoxygenParam parameter: thing
+        ├─ DoxygenParameter parameter: thing
         │  └─ Paragraph
         │     └─ Text "The thing."
         └─ BlockDirective name: "Comment"
@@ -173,7 +173,7 @@ class DoxygenCommandParserTests: XCTestCase {
         Document
         ├─ Paragraph
         │  └─ Text "This is a paragraph."
-        └─ DoxygenParam parameter: thing
+        └─ DoxygenParameter parameter: thing
            └─ Paragraph
               └─ Text "The thing."
         """
@@ -191,7 +191,7 @@ class DoxygenCommandParserTests: XCTestCase {
         // FIXME: The source location for the first description line is wrong
         let expectedDump = """
         Document @1:1-2:39
-        └─ DoxygenParam @1:1-2:39 parameter: thing
+        └─ DoxygenParameter @1:1-2:39 parameter: thing
            └─ Paragraph @1:14-2:39
               ├─ Text @1:14-1:24 "The thing."
               ├─ SoftBreak