Fix some DocC warnings. (#188)

* Fix some DocC warnings. * Update Deprecations.swift --------- Co-authored-by: Stephen Celis <[email protected]>
pointfreeco · Jul 31, 2024 · 9f36d95 · 9f36d95
1 parent 9df83d0
commit 9f36d95
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 37 deletions.
diff --git a/Sources/CasePaths/CasePathable.swift b/Sources/CasePaths/CasePathable.swift
@@ -476,6 +476,10 @@ extension CasePathable {
   /// - Parameters:
   ///   - keyPath: A case key path to an associated value.
   ///   - yield: A closure given mutable access to that associated value.
+  ///   - fileID: The fileID where the modify occurs.
+  ///   - filePath: The filePath where the modify occurs.
+  ///   - line: The line where the modify occurs.
+  ///   - column: The column where the modify occurs.
   public mutating func modify<Value>(
     _ keyPath: CaseKeyPath<Self, Value>,
     yield: (inout Value) -> Void,

diff --git a/Sources/CasePaths/Documentation.docc/AnyCasePathDeprecations.md b/Sources/CasePaths/Documentation.docc/AnyCasePathDeprecations.md
@@ -10,13 +10,13 @@ Avoid using deprecated APIs in your app. See the replacement that you should use
 
 ### Creating paths
 
-- ``AnyCasePath/init(unsafe:)-4xq8n``
-- ``AnyCasePath/init(unsafe:)-2skr2``
+- ``AnyCasePath/init(unsafe:)-5fryq``
+- ``AnyCasePath/init(unsafe:)-93j7i``
 - ``AnyCasePath/init(_:)-5t7e8``
-- ``AnyCasePath/init(_:)-5hb2e``
+- ``AnyCasePath/init(_:)-65qkv``
 - ``AnyCasePath/init(_:)-2cuas``
-- ``AnyCasePath/case(_:)-4lmya``
-- ``AnyCasePath/case(_:)-6gkwv``
+- ``AnyCasePath/case(_:)-1k3jw``
+- ``AnyCasePath/case(_:)-g885``
 - ``AnyCasePath/constant(_:)``
 - ``AnyCasePath/self``
 - ``AnyCasePath/some``
@@ -31,13 +31,7 @@ Avoid using deprecated APIs in your app. See the replacement that you should use
 ### Appending paths
 
 - ``AnyCasePath/appending(path:)``
-- ``AnyCasePath/..(_:_:)-8bw4h``
-- ``AnyCasePath/..(_:_:)-8n2ce``
-- ``CasePaths/..(_:_:)``
-
-### Matching paths
-
-- ``AnyCasePath/~=(_:_:)``
+- ``AnyCasePath/modify(_:_:)``
 
 ### Type alias
 

diff --git a/Sources/CasePaths/Documentation.docc/CaseKeyPath.md b/Sources/CasePaths/Documentation.docc/CaseKeyPath.md
@@ -14,5 +14,4 @@
 ### Partial case paths
 
 - ``PartialCaseKeyPath``
-- ``Swift/PartialKeyPath/callAsFunction(_:)``
 - ``CasePathable/subscript(case:)-8av06``
diff --git a/Sources/CasePaths/Documentation.docc/CasePathable.md b/Sources/CasePaths/Documentation.docc/CasePathable.md
@@ -10,7 +10,7 @@
 
 - ``subscript(case:)-6cdhl``
 - ``subscript(case:)-8yr2s``
-- ``modify(_:yield:file:line:)``
+- ``modify(_:yield:fileID:filePath:line:column:)``
 
 ### Case properties
 

diff --git a/Sources/CasePaths/Documentation.docc/Deprecations.md b/Sources/CasePaths/Documentation.docc/Deprecations.md
@@ -10,7 +10,7 @@ Avoid using deprecated APIs in your app. See the replacement that you should use
 
 ### Functions
 
-- ``extract(case:from:)-89rof``
-- ``extract(case:from:)-82wth``
-- ``extract(_:)-2jy2a``
-- ``extract(_:)-5ivuf``
+- ``extract(case:from:)-262ip``
+- ``extract(case:from:)-ylkc``
+- ``extract(_:)-34fjh``
+- ``extract(_:)-3twft``
diff --git a/Sources/CasePaths/EnumReflection.swift b/Sources/CasePaths/EnumReflection.swift
@@ -11,7 +11,6 @@ extension AnyCasePath {
   /// > ``CaseKeyPath``.
   ///
   /// - Parameter embed: An embed function.
-  /// - Returns: A case path.
   @available(iOS, deprecated: 9999, message: "Use a 'CasePathable' case key path, instead")
   @available(macOS, deprecated: 9999, message: "Use a 'CasePathable' case key path, instead")
   @available(tvOS, deprecated: 9999, message: "Use a 'CasePathable' case key path, instead")
@@ -37,11 +36,6 @@ extension AnyCasePath {
   /// > Important: This operation is provided for backwards compatibility. Avoid introducing it to
   /// > your code and instead favor using types that conform to ``CasePathable`` and
   /// > ``CaseKeyPath``.
-  ///
-  /// - Note: This operator is only intended to be used with enum cases that have no associated
-  ///   values. Its behavior is otherwise undefined.
-  /// - Parameter root: A case with no an associated value.
-  /// - Returns: A void case path.
   @available(iOS, deprecated: 9999, message: "Use a 'CasePathable' case key path, instead")
   @available(macOS, deprecated: 9999, message: "Use a 'CasePathable' case key path, instead")
   @available(tvOS, deprecated: 9999, message: "Use a 'CasePathable' case key path, instead")

diff --git a/Sources/CasePaths/Internal/Deprecations.swift b/Sources/CasePaths/Internal/Deprecations.swift
@@ -208,7 +208,7 @@ public func XCTUnwrap<Enum, Case>(
   _ enum: @autoclosure () throws -> Enum,
   case extract: (Enum) -> Case?,
   _ message: @autoclosure () -> String = "",
-  file: StaticString = #file,
+  file: StaticString = #filePath,
   line: UInt = #line
 ) throws -> Case {
   let `enum` = try `enum`()
@@ -241,7 +241,7 @@ public func XCTModify<Enum, Case>(
   case casePath: AnyCasePath<Enum, Case>,
   _ message: @autoclosure () -> String = "",
   _ body: (inout Case) throws -> Void,
-  file: StaticString = #file,
+  file: StaticString = #filePath,
   line: UInt = #line
 ) {
   _XCTModify(&`enum`, case: casePath, message(), body, file: file, line: line)

diff --git a/Sources/CasePaths/XCTestSupport.swift b/Sources/CasePaths/XCTestSupport.swift
@@ -2,11 +2,6 @@ import Foundation
 @_spi(CurrentTestCase) import XCTestDynamicOverlay
 
 /// Asserts that an enum value matches a particular case and modifies the associated value in place.
-///
-/// - Parameters:
-///   - optional: An optional value.
-///   - message: An optional description of a failure.
-///   - body: A closure that can modify the wrapped value of the given optional.
 @available(*, deprecated, message: "Use 'CasePathable.modify' to mutate an expected case, instead.")
 public func XCTModify<Wrapped>(
   _ optional: inout Wrapped?,
@@ -19,12 +14,6 @@ public func XCTModify<Wrapped>(
 }
 
 /// Asserts that an enum value matches a particular case and modifies the associated value in place.
-///
-/// - Parameters:
-///   - enum: An enum value.
-///   - casePath: A case path that can extract and embed the associated value of a particular case.
-///   - message: An optional description of a failure.
-///   - body: A closure that can modify the associated value of the given case.
 @available(*, deprecated, message: "Use 'CasePathable.modify' to mutate an expected case, instead.")
 public func XCTModify<Enum, Case>(
   _ enum: inout Enum,