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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2023 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
@testable import Markdown
import XCTest
class DoxygenCommandParserTests: XCTestCase {
let parseOptions: ParseOptions = [.parseMinimalDoxygen, .parseBlockDirectives]
func testParseDiscussion() {
func assertValidParse(source: String) {
let document = Document(parsing: source, options: parseOptions)
XCTAssert(document.child(at: 0) is DoxygenDiscussion)
let expectedDump = """
Document
└─ DoxygenDiscussion
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
assertValidParse(source: "@discussion The thing.")
assertValidParse(source: #"\discussion The thing."#)
}
func testParseNote() {
func assertValidParse(source: String) {
let document = Document(parsing: source, options: parseOptions)
XCTAssert(document.child(at: 0) is DoxygenNote)
let expectedDump = """
Document
└─ DoxygenNote
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
assertValidParse(source: "@note The thing.")
assertValidParse(source: #"\note The thing."#)
}
func testParseParam() throws {
let source = """
@param thing The thing.
"""
let document = Document(parsing: source, options: parseOptions)
let param = try XCTUnwrap(document.child(at: 0) as? DoxygenParameter)
XCTAssertEqual(param.name, "thing")
let expectedDump = """
Document
└─ DoxygenParameter parameter: thing
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testParseReturns() {
func assertValidParse(source: String) {
let document = Document(parsing: source, options: parseOptions)
XCTAssert(document.child(at: 0) is DoxygenReturns)
let expectedDump = """
Document
└─ DoxygenReturns
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
assertValidParse(source: "@returns The thing.")
assertValidParse(source: "@return The thing.")
assertValidParse(source: "@result The thing.")
assertValidParse(source: #"\returns The thing."#)
assertValidParse(source: #"\return The thing."#)
assertValidParse(source: #"\result The thing."#)
}
func testParseParamWithSlash() throws {
let source = #"""
\param thing The thing.
"""#
let document = Document(parsing: source, options: parseOptions)
let param = try XCTUnwrap(document.child(at: 0) as? DoxygenParameter)
XCTAssertEqual(param.name, "thing")
let expectedDump = """
Document
└─ DoxygenParameter parameter: thing
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testParseMultilineDescription() {
let source = """
@param thing The thing.
This is the thing that is messed with.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
└─ DoxygenParameter parameter: thing
└─ Paragraph
├─ Text "The thing."
├─ SoftBreak
└─ Text "This is the thing that is messed with."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testParseIndentedDescription() {
let source = """
@param thing
The thing.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
└─ DoxygenParameter parameter: thing
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testParseMultilineIndentedDescription() {
let source = """
@param thing The thing.
This is the thing that is messed with.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
└─ DoxygenParameter parameter: thing
└─ Paragraph
├─ Text "The thing."
├─ SoftBreak
└─ Text "This is the thing that is messed with."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testParseWithIndentedAtSign() {
let source = """
Method description.
@param thing The thing.
This is the thing that is messed with.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
├─ Paragraph
│ └─ Text "Method description."
└─ DoxygenParameter parameter: thing
└─ Paragraph
├─ Text "The thing."
├─ SoftBreak
└─ Text "This is the thing that is messed with."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testBreakDescriptionWithBlankLine() {
let source = """
@param thing The thing.
Messes with the thing.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
├─ DoxygenParameter parameter: thing
│ └─ Paragraph
│ └─ Text "The thing."
└─ Paragraph
└─ Text "Messes with the thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testBreakDescriptionWithOtherCommand() {
let source = """
Messes with the thing.
@param thing The thing.
@param otherThing The other thing.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
├─ Paragraph
│ └─ Text "Messes with the thing."
├─ DoxygenParameter parameter: thing
│ └─ Paragraph
│ └─ Text "The thing."
└─ DoxygenParameter parameter: otherThing
└─ Paragraph
└─ Text "The other thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testBreakDescriptionWithBlockDirective() {
let source = """
Messes with the thing.
@param thing The thing.
@Comment {
This is supposed to be different from the above command.
}
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
├─ Paragraph
│ └─ Text "Messes with the thing."
├─ DoxygenParameter parameter: thing
│ └─ Paragraph
│ └─ Text "The thing."
└─ BlockDirective name: "Comment"
└─ Paragraph
└─ Text "This is supposed to be different from the above command."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testCommandBreaksParagraph() {
let source = """
This is a paragraph.
@param thing The thing.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
├─ Paragraph
│ └─ Text "This is a paragraph."
└─ DoxygenParameter parameter: thing
└─ Paragraph
└─ Text "The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testSourceLocations() {
let source = """
@param thing The thing.
This is the thing that is messed with.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document @1:1-2:39
└─ DoxygenParameter @1:1-2:39 parameter: thing
└─ Paragraph @1:14-2:39
├─ Text @1:14-1:24 "The thing."
├─ SoftBreak
└─ Text @2:1-2:39 "This is the thing that is messed with."
"""
XCTAssertEqual(document.debugDescription(options: .printSourceLocations), expectedDump)
}
func testSourceLocationsWithIndentation() {
let source = """
@param thing The thing.
This is the thing that is messed with.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document @1:1-2:43
└─ DoxygenParameter @1:1-2:43 parameter: thing
└─ Paragraph @1:14-2:43
├─ Text @1:14-1:24 "The thing."
├─ SoftBreak
└─ Text @2:5-2:43 "This is the thing that is messed with."
"""
XCTAssertEqual(document.debugDescription(options: .printSourceLocations), expectedDump)
}
func testSourceLocationsWithIndentedAtSign() {
let source = """
Method description.
@param thing The thing.
This is the thing that is messed with.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document @1:1-4:43
├─ Paragraph @1:1-1:20
│ └─ Text @1:1-1:20 "Method description."
└─ DoxygenParameter @3:2-4:43 parameter: thing
└─ Paragraph @3:15-4:43
├─ Text @3:15-3:25 "The thing."
├─ SoftBreak
└─ Text @4:5-4:43 "This is the thing that is messed with."
"""
XCTAssertEqual(document.debugDescription(options: .printSourceLocations), expectedDump)
}
func testDoesNotParseWithoutOption() {
do {
let source = """
@param thing The thing.
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let expectedDump = """
Document
└─ BlockDirective name: "param"
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
do {
let source = """
@param thing The thing.
"""
let document = Document(parsing: source)
let expectedDump = """
Document
└─ Paragraph
└─ Text "@param thing The thing."
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
}
func testDoesNotParseInsideBlockDirective() {
let source = """
@Comment {
@param thing The thing.
}
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
└─ BlockDirective name: "Comment"
└─ BlockDirective name: "param"
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
func testDoesNotParseInsideCodeBlock() {
do {
let source = """
```
@param thing The thing.
```
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
└─ CodeBlock language: none
@param thing The thing.
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
do {
let source = """
Paragraph to set indentation.
@param thing The thing.
"""
let document = Document(parsing: source, options: parseOptions)
let expectedDump = """
Document
├─ Paragraph
│ └─ Text "Paragraph to set indentation."
└─ CodeBlock language: none
@param thing The thing.
"""
XCTAssertEqual(document.debugDescription(), expectedDump)
}
}
func testDoesNotParseUnknownCommand() {
let source = #"""
\unknown
"""#
let document = Document(parsing: source, options: parseOptions)
let expectedDump = #"""
Document
└─ Paragraph
└─ Text "\unknown"
"""#
XCTAssertEqual(document.debugDescription(), expectedDump)
}
}
|
