blob: 6b00f2f003c33ec12c18719f386bb789dedf3b57 (
plain)
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
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package model
import org.jetbrains.dokka.model.DClass
import org.jetbrains.dokka.model.DProperty
import org.jetbrains.dokka.model.doc.*
import utils.AbstractModelTest
import utils.assertNotNull
import utils.comments
import utils.docs
import kotlin.test.Test
class CommentTest : AbstractModelTest("/src/main/kotlin/comment/Test.kt", "comment") {
@Test
fun codeBlockComment() {
inlineModelTest(
"""
|/**
| * ```brainfuck
| * ++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>.
| * ```
| */
|val prop1 = ""
|
|
|/**
| * ```
| * a + b - c
| * ```
| */
|val prop2 = ""
"""
) {
with((this / "comment" / "prop1").cast<DProperty>()) {
name equals "prop1"
with(this.docs().firstOrNull()?.children?.firstOrNull()?.assertNotNull("Code")) {
(this?.children?.firstOrNull() as? Text)
?.body equals "++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>."
this?.params?.get("lang") equals "brainfuck"
}
}
with((this / "comment" / "prop2").cast<DProperty>()) {
name equals "prop2"
with(this.docs().firstOrNull()?.children?.firstOrNull()?.assertNotNull("Code")) {
(this?.children?.firstOrNull() as? Text)
?.body equals "a + b - c"
this?.params?.get("lang") equals null
}
}
}
}
@Test
fun codeBlockWithIndentationComment() {
inlineModelTest(
"""
|/**
| * 1.
| * ```
| * line 1
| * line 2
| * ```
| */
|val prop1 = ""
"""
) {
with((this / "comment" / "prop1").cast<DProperty>()) {
name equals "prop1"
with(this.docs().firstOrNull()?.children?.firstOrNull()?.assertNotNull("Code")) {
val codeBlockChildren = ((this?.children?.firstOrNull() as? Li)?.children?.firstOrNull() as? CodeBlock)?.children
(codeBlockChildren?.get(0) as? Text)?.body equals " line 1"
(codeBlockChildren?.get(1) as? Br) notNull "Br"
(codeBlockChildren?.get(2) as? Text)?.body equals " line 2"
}
}
}
}
@Test
fun emptyDoc() {
inlineModelTest(
"""
val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
name equals "property"
comments() equals ""
}
}
}
@Test
fun emptyDocButComment() {
inlineModelTest(
"""
|/* comment */
|val property = "test"
|fun tst() = property
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals ""
}
}
}
@Test
fun multilineDoc() {
inlineModelTest(
"""
|/**
| * doc1
| *
| * doc2
| * doc3
| */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "doc1\ndoc2 doc3\n"
}
}
}
@Test
fun multilineDocWithComment() {
inlineModelTest(
"""
|/**
| * doc1
| *
| * doc2
| * doc3
| */
|// comment
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "doc1\ndoc2 doc3\n"
}
}
}
@Test
fun oneLineDoc() {
inlineModelTest(
"""
|/** doc */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "doc\n"
}
}
}
@Test
fun oneLineDocWithComment() {
inlineModelTest(
"""
|/** doc */
|// comment
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "doc\n"
}
}
}
@Test
fun oneLineDocWithEmptyLine() {
inlineModelTest(
"""
|/** doc */
|
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "doc\n"
}
}
}
@Test
fun emptySection() {
inlineModelTest(
"""
|/**
| * Summary
| * @one
| */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "Summary\n\none: []"
with(docs().find { it is CustomTagWrapper && it.name == "one" }.assertNotNull("'one' entry")) {
root.children counts 0
root.params.keys counts 0
}
}
}
}
@Test
fun quotes() {
inlineModelTest(
"""
|/** it's "useful" */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals """it's "useful"
"""
}
}
}
@Test
fun section1() {
inlineModelTest(
"""
|/**
| * Summary
| * @one section one
| */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "Summary\n\none: [section one\n]"
}
}
}
@Test
fun section2() {
inlineModelTest(
"""
|/**
| * Summary
| * @one section one
| * @two section two
| */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "Summary\n\none: [section one\n]\ntwo: [section two\n]"
}
}
}
@Test
fun multilineSection() {
inlineModelTest(
"""
|/**
| * Summary
| * @one
| * line one
| * line two
| */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "Summary\n\none: [line one line two\n]"
}
}
}
@Test
fun `should be space between Markdown nodes`() {
inlineModelTest(
"""
|/**
| * Rotates paths by `amount` **radians** around (`x`, `y`).
| */
|val property = "test"
"""
) {
with((this / "comment" / "property").cast<DProperty>()) {
comments() equals "Rotates paths by amount radians around (x, y).\n"
}
}
}
@Test
fun `should remove spaces inside indented code block`() {
inlineModelTest(
"""
|/**
| * Welcome:
| *
| * ```kotlin
| * fun main() {
| * println("Hello World!")
| * }
| * ```
| *
| * fun thisIsACodeBlock() {
| * val butWhy = "per markdown spec, because four-spaces prefix"
| * }
| */
|class Foo
"""
) {
with((this / "comment" / "Foo").cast<DClass>()) {
docs()[0].children[2] equals CodeBlock(
listOf(
Text(
"fun thisIsACodeBlock() {\n" +
" val butWhy = \"per markdown spec, because four-spaces prefix\"\n" +
"}"
)
)
)
}
}
}
}
|
