Skip to content

Commit 595efae

Browse files
DocC-fixes.
1 parent cfeb486 commit 595efae

4 files changed

Lines changed: 21 additions & 21 deletions

File tree

Sources/kvKit/KvDebug.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public class KvDebug {
129129

130130

131131
#if DEBUG
132-
/// Analog of standard ``Swift/assert``() providing ability to continue execution.
132+
/// Analog of standard `assert` providing ability to continue execution.
133133
///
134134
/// - Note: Use *Swift Error Breakpoint* to pause execution.
135135
///
@@ -142,7 +142,7 @@ public class KvDebug {
142142
}
143143

144144
#else // !DEBUG
145-
/// Analog of standard ``Swift/assert``() providing ability to continue execution.
145+
/// Analog of standard `assert` providing ability to continue execution.
146146
///
147147
/// - Note: Use *Swift Error Breakpoint* to pause execution.
148148
///

Sources/kvKit/KvMetalKit.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ extension KvMetalKit {
303303

304304
/// Calculates 1D-grid for given *pipelineState*.
305305
///
306-
/// See ``init(_:texture1D:)``, ``threadgroupSize(_:width)``.
306+
/// See ``init(_:texture1D:)``, ``threadgroupSize(_:width:)``.
307307
@inlinable
308308
public init(_ pipelineState: MTLComputePipelineState, width: Int) {
309309
self.init(pipelineState,
@@ -314,7 +314,7 @@ extension KvMetalKit {
314314

315315
/// Calculates 1D-grid for given *pipelineState* of the same size as given *texture1D*.
316316
///
317-
/// See ``init(_:width:)``, ``threadgroupSize(_:width)``.
317+
/// See ``init(_:width:)``, ``threadgroupSize(_:width:)``.
318318
@inlinable
319319
public init(_ pipelineState: MTLComputePipelineState, texture1D: MTLTexture) {
320320
self.init(pipelineState, width: texture1D.width)

Sources/kvTestKit/KvMathTestKit.swift

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,98 +27,98 @@ import XCTest
2727

2828

2929

30-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
30+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
3131
@inlinable
3232
public func KvAssertEqual<T : KvNumericallyEquatable>(_ result: T, _ expected: T, _ message: @autoclosure () -> String = "") {
3333
KvAssertEqual(result, expected, by: T.isEqual(_:to:), message())
3434
}
3535

36-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
36+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
3737
@inlinable
3838
public func KvAssertEqual<T : KvNumericallyEquatable>(_ result: T?, _ expected: T?, _ message: @autoclosure () -> String = "") {
3939
KvAssertEqual(result, expected, by: T.isEqual(_:to:), message())
4040
}
4141

4242

43-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
43+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
4444
@inlinable
4545
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Vector2, _ expected: Math.Vector2, _ message: @autoclosure () -> String = "") {
4646
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
4747
}
4848

49-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
49+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
5050
@inlinable
5151
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Vector2?, _ expected: Math.Vector2?, _ message: @autoclosure () -> String = "") {
5252
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
5353
}
5454

55-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
55+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
5656
@inlinable
5757
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Vector3, _ expected: Math.Vector3, _ message: @autoclosure () -> String = "") {
5858
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
5959
}
6060

61-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
61+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
6262
@inlinable
6363
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Vector3?, _ expected: Math.Vector3?, _ message: @autoclosure () -> String = "") {
6464
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
6565
}
6666

67-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
67+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
6868
@inlinable
6969
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Vector4, _ expected: Math.Vector4, _ message: @autoclosure () -> String = "") {
7070
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
7171
}
7272

73-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
73+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
7474
@inlinable
7575
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Vector4?, _ expected: Math.Vector4?, _ message: @autoclosure () -> String = "") {
7676
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
7777
}
7878

79-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
79+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
8080
@inlinable
8181
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Quaternion, _ expected: Math.Quaternion, _ message: @autoclosure () -> String = "") {
8282
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
8383
}
8484

85-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
85+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
8686
@inlinable
8787
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Quaternion?, _ expected: Math.Quaternion?, _ message: @autoclosure () -> String = "") {
8888
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
8989
}
9090

91-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
91+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
9292
@inlinable
9393
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Matrix2x2, _ expected: Math.Matrix2x2, _ message: @autoclosure () -> String = "") {
9494
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
9595
}
9696

97-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
97+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
9898
@inlinable
9999
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Matrix2x2?, _ expected: Math.Matrix2x2?, _ message: @autoclosure () -> String = "") {
100100
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
101101
}
102102

103-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
103+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
104104
@inlinable
105105
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Matrix3x3, _ expected: Math.Matrix3x3, _ message: @autoclosure () -> String = "") {
106106
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
107107
}
108108

109-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
109+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
110110
@inlinable
111111
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Matrix3x3?, _ expected: Math.Matrix3x3?, _ message: @autoclosure () -> String = "") {
112112
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
113113
}
114114

115-
/// Invokes ``XCTFail``() when *result* and *expectation* are not numerically equal.
115+
/// Invokes `XCTFail` when *result* and *expectation* are not numerically equal.
116116
@inlinable
117117
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Matrix4x4, _ expected: Math.Matrix4x4, _ message: @autoclosure () -> String = "") {
118118
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())
119119
}
120120

121-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
121+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *result* and *expectation* are not numerically equal.
122122
@inlinable
123123
public func KvAssertEqual<Math : KvMathScope>(_ math: Math.Type, _ result: Math.Matrix4x4?, _ expected: Math.Matrix4x4?, _ message: @autoclosure () -> String = "") {
124124
KvAssertEqual(result, expected, by: Math.isEqual(_:_:), message())

Sources/kvTestKit/KvTestKit.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import XCTest
2525

2626

2727

28-
/// Invokes ``XCTFail``() when *result* and *expectation* are not both `nil` or *isEqual*(*result*, *expectation*) doesn't return *true*.
28+
/// Invokes `XCTFail` when *result* and *expectation* are not both `nil` or *isEqual*(*result*, *expectation*) doesn't return *true*.
2929
@inlinable
3030
public func KvAssertEqual<R, E>(_ result: R?, _ expectation: E?, by isEqual: (R, E) -> Bool, _ message: @autoclosure () -> String = "") {
3131
switch (result, expectation) {

0 commit comments

Comments
 (0)