1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
import _SwiftFormatTestSupport
@_spi(Rules) import SwiftFormat
// FIXME: Diagnostics should be emitted inside the comment, not at the beginning of the declaration.
final class ValidateDocumentationCommentsTests: LintOrFormatRuleTestCase {
func testParameterDocumentation() {
assertLint(
ValidateDocumentationComments.self,
"""
/// Uses 'Parameters' when it only has one parameter.
///
/// - Parameters:
/// - singular: singular description.
/// - Returns: A string containing the contents of a
/// description
1️⃣func testPluralParamDesc(singular: String) -> Bool {}
/// Returns the output generated by executing a command with the given string
/// used as standard input.
///
/// - Parameter command: The command to execute in the shell environment.
/// - Parameter stdin: The string to use as standard input.
/// - Returns: A string containing the contents of the invoked process's
/// standard output.
2️⃣func testInvalidParameterDesc(command: String, stdin: String) -> String {}
""",
findings: [
FindingSpec("1️⃣", message: "replace the plural 'Parameters:' section with a singular inline 'Parameter' section"),
FindingSpec("2️⃣", message: "replace the singular inline 'Parameter' section with a plural 'Parameters:' section that has the parameters nested inside it"),
]
)
}
func testParametersName() {
assertLint(
ValidateDocumentationComments.self,
"""
/// Parameters dont match.
///
/// - Parameters:
/// - sum: The sum of all numbers.
/// - avg: The average of all numbers.
/// - Returns: The sum of sum and avg.
1️⃣func sum(avg: Int, sum: Int) -> Int {}
/// Missing one parameter documentation.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - Returns: an integer.
2️⃣func foo(p1: Int, p2: Int, p3: Int) -> Int {}
""",
findings: [
FindingSpec("1️⃣", message: "change the parameters of the documentation of 'sum' to match its parameters"),
FindingSpec("2️⃣", message: "change the parameters of the documentation of 'foo' to match its parameters"),
]
)
}
func testThrowsDocumentation() {
assertLint(
ValidateDocumentationComments.self,
"""
/// One sentence summary.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - p3: Parameter 3.
/// - Throws: an error.
1️⃣func doesNotThrow(p1: Int, p2: Int, p3: Int) {}
/// One sentence summary.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - p3: Parameter 3.
func doesThrow(p1: Int, p2: Int, p3: Int) 2️⃣throws {}
/// One sentence summary.
///
/// - Parameter p1: Parameter 1.
/// - Throws: doesn't really throw, just rethrows
func doesRethrow(p1: (() throws -> ())) 3️⃣rethrows {}
""",
findings: [
FindingSpec("1️⃣", message: "remove the 'Throws:' sections of 'doesNotThrow'; it does not throw any errors"),
FindingSpec("2️⃣", message: "add a 'Throws:' section to document the errors thrown by 'doesThrow'"),
FindingSpec("3️⃣", message: "remove the 'Throws:' sections of 'doesRethrow'; it does not throw any errors"),
]
)
}
func testReturnDocumentation() {
assertLint(
ValidateDocumentationComments.self,
"""
/// One sentence summary.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - p3: Parameter 3.
/// - Returns: an integer.
1️⃣func noReturn(p1: Int, p2: Int, p3: Int) {}
/// One sentence summary.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - p3: Parameter 3.
func foo(p1: Int, p2: Int, p3: Int) 2️⃣-> Int {}
/// One sentence summary.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - p3: Parameter 3.
func neverReturns(p1: Int, p2: Int, p3: Int) -> Never {}
/// One sentence summary.
///
/// - Parameters:
/// - p1: Parameter 1.
/// - p2: Parameter 2.
/// - p3: Parameter 3.
/// - Returns: Never returns.
func documentedNeverReturns(p1: Int, p2: Int, p3: Int) -> Never {}
""",
findings: [
FindingSpec("1️⃣", message: "remove the 'Returns:' section of 'noReturn'; it does not return a value"),
FindingSpec("2️⃣", message: "add a 'Returns:' section to document the return value of 'foo'"),
]
)
}
func testValidDocumentation() {
assertLint(
ValidateDocumentationComments.self,
"""
/// Returns the output generated by executing a command.
///
/// - Parameter command: The command to execute in the shell environment.
/// - Returns: A string containing the contents of the invoked process's
/// standard output.
func singularParam(command: String) -> String {
// ...
}
/// Returns the output generated by executing a command with the given string
/// used as standard input.
///
/// - Parameters:
/// - command: The command to execute in the shell environment.
/// - stdin: The string to use as standard input.
/// - Throws: An error, possibly.
/// - Returns: A string containing the contents of the invoked process's
/// standard output.
func pluralParam(command: String, stdin: String) throws -> String {
// ...
}
/// One sentence summary.
///
/// - Parameter p1: Parameter 1.
func rethrower(p1: (() throws -> ())) rethrows {
// ...
}
/// Parameter(s) and Returns tags may be omitted only if the single-sentence
/// brief summary fully describes the meaning of those items and including the
/// tags would only repeat what has already been said
func omittedFunc(p1: Int)
""",
findings: []
)
}
func testSeparateLabelAndIdentifier() {
assertLint(
ValidateDocumentationComments.self,
"""
/// Returns the output generated by executing a command.
///
/// - Parameter command: The command to execute in the shell environment.
/// - Returns: A string containing the contents of the invoked process's
/// standard output.
1️⃣func incorrectParam(label commando: String) -> String {
// ...
}
/// Returns the output generated by executing a command.
///
/// - Parameter command: The command to execute in the shell environment.
/// - Returns: A string containing the contents of the invoked process's
/// standard output.
func singularParam(label command: String) -> String {
// ...
}
/// Returns the output generated by executing a command with the given string
/// used as standard input.
///
/// - Parameters:
/// - command: The command to execute in the shell environment.
/// - stdin: The string to use as standard input.
/// - Returns: A string containing the contents of the invoked process's
/// standard output.
func pluralParam(label command: String, label2 stdin: String) -> String {
// ...
}
""",
findings: [
FindingSpec("1️⃣", message: "change the parameters of the documentation of 'incorrectParam' to match its parameters"),
]
)
}
func testInitializer() {
assertLint(
ValidateDocumentationComments.self,
"""
struct SomeType {
/// Brief summary.
///
/// - Parameter command: The command to execute in the shell environment.
/// - Returns: Shouldn't be here.
1️⃣2️⃣init(label commando: String) {
// ...
}
/// Brief summary.
///
/// - Parameter command: The command to execute in the shell environment.
init(label command: String) {
// ...
}
/// Brief summary.
///
/// - Parameters:
/// - command: The command to execute in the shell environment.
/// - stdin: The string to use as standard input.
init(label command: String, label2 stdin: String) {
// ...
}
/// Brief summary.
///
/// - Parameters:
/// - command: The command to execute in the shell environment.
/// - stdin: The string to use as standard input.
/// - Throws: An error.
init(label command: String, label2 stdin: String) throws {
// ...
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove the 'Returns:' section of 'init'; it does not return a value"),
FindingSpec("2️⃣", message: "change the parameters of the documentation of 'init' to match its parameters"),
]
)
}
}
|
