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
|
import SwiftSyntax
import SwiftSyntaxBuilder
import XCTest
@_spi(Testing) import SwiftFormat
final class DocumentationCommentTextTests: XCTestCase {
func testSimpleDocLineComment() throws {
let decl: DeclSyntax = """
/// A simple doc comment.
func f() {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .line)
XCTAssertEqual(
commentText.text,
"""
A simple doc comment.
"""
)
}
func testOneLineDocBlockComment() throws {
let decl: DeclSyntax = """
/** A simple doc comment. */
func f() {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .block)
XCTAssertEqual(
commentText.text,
"""
A simple doc comment.\u{0020}
"""
)
}
func testDocBlockCommentWithASCIIArt() throws {
let decl: DeclSyntax = """
/**
* A simple doc comment.
*/
func f() {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .block)
XCTAssertEqual(
commentText.text,
"""
A simple doc comment.
"""
)
}
func testIndentedDocBlockCommentWithASCIIArt() throws {
let decl: DeclSyntax = """
/**
* A simple doc comment.
*/
func f() {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .block)
XCTAssertEqual(
commentText.text,
"""
A simple doc comment.
"""
)
}
func testDocBlockCommentWithoutASCIIArt() throws {
let decl: DeclSyntax = """
/**
A simple doc comment.
*/
func f() {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .block)
XCTAssertEqual(
commentText.text,
"""
A simple doc comment.
"""
)
}
func testMultilineDocLineComment() throws {
let decl: DeclSyntax = """
/// A doc comment.
///
/// This is a longer paragraph,
/// containing more detail.
///
/// - Parameter x: A parameter.
/// - Returns: A value.
func f(x: Int) -> Int {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .line)
XCTAssertEqual(
commentText.text,
"""
A doc comment.
This is a longer paragraph,
containing more detail.
- Parameter x: A parameter.
- Returns: A value.
"""
)
}
func testDocLineCommentStopsAtBlankLine() throws {
let decl: DeclSyntax = """
/// This should not be part of the comment.
/// A doc comment.
func f(x: Int) -> Int {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .line)
XCTAssertEqual(
commentText.text,
"""
A doc comment.
"""
)
}
func testDocBlockCommentStopsAtBlankLine() throws {
let decl: DeclSyntax = """
/** This should not be part of the comment. */
/**
* This is part of the comment.
*/
/** so is this */
func f(x: Int) -> Int {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .block)
XCTAssertEqual(
commentText.text,
"""
This is part of the comment.
so is this\u{0020}
"""
)
}
func testDocCommentHasMixedIntroducers() throws {
let decl: DeclSyntax = """
/// This is part of the comment.
/** This is too. */
func f(x: Int) -> Int {}
"""
let commentText = try XCTUnwrap(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
XCTAssertEqual(commentText.introducer, .mixed)
XCTAssertEqual(
commentText.text,
"""
This is part of the comment.
This is too.\u{0020}
"""
)
}
func testNilIfNoComment() throws {
let decl: DeclSyntax = """
func f(x: Int) -> Int {}
"""
XCTAssertNil(DocumentationCommentText(extractedFrom: decl.leadingTrivia))
}
}
|
