Fix method documentation broken links

Author: o-nnerb

Sources/InlineSnapshotTesting/AssertInline.swift

@@ -23,16 +23,17 @@ import SwiftSyntaxBuilder
 ///   - serialization: The strategy used to serialize the snapshot data. Defaults to `DataSerialization()`.
 ///   - closureDescriptor: An optional descriptor describing the inline snapshot’s location. Typically not needed unless implementing custom helpers.
 ///   - expected: An optional closure that returns a previously generated snapshot value. When omitted, the expected value will be populated inline at the call site.
+///   - isolation: Optionally specify an actor for input evaluation, supporting thread/actor isolation. Defaults to current context.   
 ///   - fileID: The file ID in which the assertion was called. Defaults to the file ID of the test case.
-///   - file: The file path in which the assertion was called. Defaults to the file path of the test case.
+///   - filePath: The file path in which the assertion was called. Defaults to the file path of the test case.
 ///   - function: The function name in which the assertion was called. Defaults to the test method name.
 ///   - line: The line number on which the assertion was called. Defaults to the line number of the call site.
 ///   - column: The column on which the assertion was called. Defaults to the column number of the call site.
 /// - Throws: Rethrows any error thrown by the value provider or snapshot strategy.
 /// - Important: When using the Swift Testing framework, you must explicitly set the @Suite(.finalizeSnapshots) trait to ensure inline snapshots are written correctly.
 /// - SeeAlso: <doc:InlineSnapshotTesting>
 public func assertInline<Input: Sendable, Output: BytesRepresentable>(
-    of value: @autoclosure @Sendable () throws -> Input,
+    of value: @autoclosure @Sendable () async throws -> Input,
     as snapshot: AsyncSnapshot<Input, Output>,
     message: @autoclosure @escaping @Sendable () -> String = "",
     record: RecordMode? = nil,
@@ -41,6 +42,7 @@ public func assertInline<Input: Sendable, Output: BytesRepresentable>(
     serialization: DataSerialization = DataSerialization(),
     closureDescriptor: SnapshotClosureDescriptor = SnapshotClosureDescriptor(),
     matches expected: (@Sendable () -> Output.RawValue)? = nil,
+    isolation: isolated Actor? = #isolation,
     fileID: StaticString = #fileID,
     file filePath: StaticString = #filePath,
     function: StaticString = #function,
@@ -108,7 +110,7 @@ public func assertInline<Input: Sendable, Output: BytesRepresentable>(
 ///   - closureDescriptor: An optional descriptor for the inline snapshot’s location. Typically not needed unless implementing custom helpers.
 ///   - expected: An optional closure that returns a previously generated snapshot value. When omitted, the expected value will be populated inline at the call site.
 ///   - fileID: The file ID in which the assertion was called. Defaults to the file ID of the test case.
-///   - file: The file path in which the assertion was called. Defaults to the file path of the test case.
+///   - filePath: The file path in which the assertion was called. Defaults to the file path of the test case.
 ///   - function: The function name in which the assertion was called. Defaults to the test method name.
 ///   - line: The line number on which the assertion was called. Defaults to the line number of the call site.
 ///   - column: The column on which the assertion was called. Defaults to the column number of the call site.

Sources/InlineSnapshotTesting/Documentation.docc/InlineSnapshotTesting.md

@@ -3,12 +3,12 @@
 /// A structure that describes the location of an inline snapshot.
 ///
 /// Provide this structure when defining custom snapshot functions that call
-/// ``assertInline(of:as:message:record:timeout:name:serialization:closureDescriptor:matches:fileID:file:function:line:column:)-(_,AsyncSnapshot<Input, Output>,_,_,_,_,_,_,_,_,_,_,_,_)``
+/// ``InlineSnapshotTesting/assertInline(of:as:message:record:timeout:name:serialization:closureDescriptor:matches:fileID:file:function:line:column:)``
 /// under the hood.
 /// A descriptor for the trailing closure used to supply an inline snapshot in a custom snapshot assertion.
 ///
 /// Use this type when implementing custom snapshot assertion utilities that ultimately delegate to
-/// ``assertInline(of:as:message:record:timeout:name:serialization:closureDescriptor:matches:fileID:file:function:line:column:)``.
+/// ``InlineSnapshotTesting/assertInline(of:as:message:record:timeout:name:serialization:closureDescriptor:matches:fileID:file:function:line:column:)``.
 /// It describes the structure of the inline snapshot trailing closure, supporting both current and deprecated closure labels,
 /// as well as more advanced cases where multiple trailing closures may exist.
 ///
@@ -88,7 +88,7 @@ public struct SnapshotClosureDescriptor: Sendable, Hashable {
     ///   - message: An optional description of the assertion, for inclusion in test results.
     ///   - fileID: The file ID in which failure occurred. Defaults to the file ID of the test case
     ///     in which this function was called.
-    ///   - file: The file in which failure occurred. Defaults to the file path of the test case in
+    ///   - filePath: The file in which failure occurred. Defaults to the file path of the test case in
     ///     which this function was called.
     ///   - line: The line number on which failure occurred. Defaults to the line number on which
     ///     this function was called.

Sources/InlineSnapshotTesting/SwiftSyntax/SnapshotClosureDescriptor.swift

@@ -19,7 +19,7 @@ import Foundation
 ///   - timeout: Time in seconds before the assertion fails for taking too long. Defaults to zero (no timeout).
 ///   - isolation: Optionally specify an actor for input evaluation, supporting thread/actor isolation. Defaults to current context.
 ///   - fileID: The unique identifier for the file in which the assertion appears. Supplied automatically by the compiler.
-///   - file: The file path where the assertion is called. Supplied automatically by the compiler.
+///   - filePath: The file path where the assertion is called. Supplied automatically by the compiler.
 ///   - testName: The name of the test function calling the assertion. Supplied automatically by the compiler.
 ///   - line: The source line number where the assertion is called. Supplied automatically by the compiler.
 ///   - column: The source column where the assertion is called. Supplied automatically by the compiler.
@@ -30,7 +30,8 @@ import Foundation
 ///   avoid snapshot counting issues. Automatic snapshot naming relies on the call site position.
 ///
 /// - Note: The recording mode falls back to session-level or environment settings if not provided.
-///   Use testing traits, or ``withTestingEnvironment(record:operation:)`` to control globally.
+///   Use testing traits, or ``withTestingEnvironment(record:diffTool:maxConcurrentTests:platform:operation:file:line:)``
+///   to control globally.
 ///
 /// - Example:
 ///   ```swift
@@ -98,7 +99,7 @@ public func assert<Input: Sendable, Output: BytesRepresentable>(
 ///   - timeout: Maximum seconds to wait for input evaluation per assertion. Defaults to `.zero`.
 ///   - isolation: Optionally specify an actor context for input evaluation, supporting actor/thread isolation. Defaults to current context.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion in the source file. Provided automatically.
 ///   - column: The column number of the assertion in the source file. Provided automatically.
@@ -166,7 +167,7 @@ public func assert<Input: Sendable, Output: BytesRepresentable>(
 ///   - timeout: Maximum seconds to wait for input evaluation per assertion. Defaults to `.zero`.
 ///   - isolation: Optionally specify an actor context for input evaluation, supporting actor/thread isolation. Defaults to current context.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion in the source file. Provided automatically.
 ///   - column: The column number of the assertion in the source file. Provided automatically.
@@ -245,7 +246,7 @@ public func assert<Input: Sendable, Output: BytesRepresentable>(
 ///   - snapshotDirectory: Optionally specify a custom directory for stored snapshots, overriding the default.
 ///   - timeout: Time in seconds before the assertion fails if too long. Defaults to 5 seconds.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion call. Provided automatically.
 ///   - column: The column number of the assertion call. Provided automatically.
@@ -318,7 +319,7 @@ public func assert<Input, Output: BytesRepresentable>(
 ///   - snapshotDirectory: Optionally specify a custom directory for storing or comparing snapshots, overriding the default.
 ///   - timeout: Maximum seconds to wait for each assertion. Defaults to 5.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion in the source file. Provided automatically.
 ///   - column: The column number of the assertion in the source file. Provided automatically.
@@ -382,7 +383,7 @@ public func assert<Input, Output: BytesRepresentable>(
 ///   - snapshotDirectory: Optionally specify a custom directory for storing or comparing snapshots, overriding the default.
 ///   - timeout: Maximum seconds to wait for each assertion. Defaults to 5.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion in the source file. Provided automatically.
 ///   - column: The column number of the assertion in the source file. Provided automatically.
@@ -448,7 +449,7 @@ public func assert<Input, Output: BytesRepresentable>(
 ///   - timeout: Maximum seconds to wait for input evaluation or snapshotting. Defaults to `.zero`.
 ///   - isolation: Optionally specify an actor for input evaluation, supporting thread/actor isolation. Defaults to current context.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion in the source file. Provided automatically.
 ///   - column: The column number of the assertion in the source file. Provided automatically.
@@ -511,7 +512,7 @@ public func verify<Input: Sendable, Output: BytesRepresentable>(
 ///   - snapshotDirectory: Optionally specify a directory for storing or comparing snapshots, overriding the default.
 ///   - timeout: Maximum seconds to wait for input evaluation or snapshotting. Defaults to 5 seconds.
 ///   - fileID: The unique identifier of the source file. Provided automatically by the compiler.
-///   - file: The path to the source file. Provided automatically.
+///   - filePath: The path to the source file. Provided automatically.
 ///   - testName: The name of the test function. Provided automatically.
 ///   - line: The line number of the assertion in the source file. Provided automatically.
 ///   - column: The column number of the assertion in the source file. Provided automatically.

Sources/SnapshotTesting/Documentation.docc/Documentation.md

@@ -30,7 +30,7 @@ public struct SnapshotAttachment: Sendable {
     /// Initializes a `SnapshotAttachment` with a custom uniform type identifier, name, and payload.
     ///
     /// - Parameters:
-    ///   - uniformTypeIdentifier: The uniform type identifier for the attachment. Defaults to `"public.data"` if `nil`.
+    ///   - identifier: The uniform type identifier for the attachment. Defaults to `"public.data"` if `nil`.
     ///   - name: An optional name for the attachment.
     ///   - payload: The binary data payload. Defaults to `nil` if not provided.
     public init(uniformTypeIdentifier identifier: String?, name: String?, payload: Data?) {
@@ -42,7 +42,7 @@ public struct SnapshotAttachment: Sendable {
     /// Initializes a `SnapshotAttachment` with raw data, using a default uniform type identifier.
     ///
     /// - Parameters:
-    ///   - data: The binary data to use as the payload.
+    ///   - payload: The binary data to use as the payload.
     ///
     /// - SeeAlso: Uses `"public.data"` as the uniform type identifier.
     public init(data payload: Data) {
@@ -56,7 +56,7 @@ public struct SnapshotAttachment: Sendable {
     ///
     /// - Parameters:
     ///   - payload: The binary data to use as the payload.
-    ///   - uniformTypeIdentifier: The uniform type identifier for the attachment.
+    ///   - identifier: The uniform type identifier for the attachment.
     public init(data payload: Data, uniformTypeIdentifier identifier: String) {
         self.init(
             uniformTypeIdentifier: identifier,

Sources/SnapshotTesting/Documentation.docc/SnapshotsTrait.md

@@ -32,7 +32,7 @@ import Foundation
 /// without modifying individual test files.
 ///
 /// ## See Also
-/// - ``withTestingEnvironment(diffTool:_:)``
+/// - ``withTestingEnvironment(record:diffTool:maxConcurrentTests:platform:operation:file:line:)``
 /// - ``DiffTool/ksdiff``
 /// - ``DiffTool/default``
 ///
@@ -79,7 +79,7 @@ public struct DiffTool: Sendable, ExpressibleByStringLiteral {
     /// - Use Cases:
     ///   - Suitable for CI environments or when no external diff tool is available.
     ///   - Provides clear next steps for developers to configure more advanced comparison tools.
-    /// - SeeAlso: ``DiffTool/ksdiff``, ``withTestingEnvironment(diffTool:_:)``
+    /// - SeeAlso: ``DiffTool/ksdiff``, ``withTestingEnvironment(record:diffTool:maxConcurrentTests:platform:operation:file:line:)``
     public static let `default` = Self {
         """
         @−