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
|
package content.functions
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.TypeConstructor
import org.jetbrains.dokka.model.DClass
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.pages.*
import org.junit.Assert.assertEquals
import org.junit.jupiter.api.Test
import kotlin.test.assertNull
class ContentForBriefTest : BaseAbstractTest() {
private val testConfiguration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
analysisPlatform = "jvm"
}
}
}
private val codeWithSecondaryAndPrimaryConstructorsDocumented =
"""
|/src/main/kotlin/test/source.kt
|package test
|
|/**
| * Dummy text.
| *
| * @constructor constructor docs
| * @param exampleParameter dummy parameter.
| */
|class Example(val exampleParameter: Int) {
|
| /**
| * secondary constructor
| * @param param1 param1 docs
| */
| constructor(param1: String) : this(1)
|}
""".trimIndent()
private val codeWithDocumentedParameter =
"""
|/src/main/kotlin/test/source.kt
|package test
|
|/**
| * Dummy text.
| *
| * @param exampleParameter dummy parameter.
| */
|class Example(val exampleParameter: Int) {
|}
""".trimIndent()
@Test
fun `primary constructor should not inherit docs from its parameter`() {
testInline(codeWithSecondaryAndPrimaryConstructorsDocumented, testConfiguration) {
pagesTransformationStage = { module ->
val classPage =
module.dfs { it.name == "Example" && (it as WithDocumentables).documentables.firstOrNull() is DClass } as ContentPage
val constructorsTable =
classPage.content.dfs { it is ContentTable && it.dci.kind == ContentKind.Constructors } as ContentTable
assertEquals(2, constructorsTable.children.size)
val primary = constructorsTable.children.first {
it.dci.dri.first().callable?.params?.first() == TypeConstructor(
"kotlin.Int",
emptyList()
)
}
val primaryConstructorDocs =
primary.dfs { it is ContentText && it.dci.kind == ContentKind.Comment } as ContentText
assertEquals("constructor docs", primaryConstructorDocs.text)
}
}
}
@Test
fun `secondary constructor should not inherit docs from its parameter`() {
testInline(codeWithSecondaryAndPrimaryConstructorsDocumented, testConfiguration) {
pagesTransformationStage = { module ->
val classPage =
module.dfs { it.name == "Example" && (it as WithDocumentables).documentables.firstOrNull() is DClass } as ContentPage
val constructorsTable =
classPage.content.dfs { it is ContentTable && it.dci.kind == ContentKind.Constructors } as ContentTable
assertEquals(2, constructorsTable.children.size)
val primary = constructorsTable.children.first {
it.dci.dri.first().callable?.params?.first() == TypeConstructor(
"kotlin.String",
emptyList()
)
}
val primaryConstructorDocs =
primary.dfs { it is ContentText && it.dci.kind == ContentKind.Comment } as ContentText
assertEquals("secondary constructor", primaryConstructorDocs.text)
}
}
}
@Test
fun `primary constructor should not inherit docs from its parameter when no specific docs are provided`() {
testInline(codeWithDocumentedParameter, testConfiguration) {
pagesTransformationStage = { module ->
val classPage =
module.dfs { it.name == "Example" && (it as WithDocumentables).documentables.firstOrNull() is DClass } as ContentPage
val constructorsTable =
classPage.content.dfs { it is ContentTable && it.dci.kind == ContentKind.Constructors } as ContentTable
assertEquals(1, constructorsTable.children.size)
val primary = constructorsTable.children.first()
val primaryConstructorDocs = primary.dfs { it is ContentText && it.dci.kind == ContentKind.Comment }
assertNull(primaryConstructorDocs, "Expected no primary constructor docs to be present")
}
}
}
@Test
fun `brief for functions should work with html`() {
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|class Example(val exampleParameter: Int) {
| /**
| * This is an example <!-- not visible --> of html
| *
| * This is definitely not a brief
| */
| fun test(): String = "TODO"
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"This is an example <!-- not visible --> of html",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
@Test
fun `brief for functions should work with ie`() {
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|class Example(val exampleParameter: Int) {
| /**
| * The user token, i.e. "Bearer xyz". Throw an exception if not available.
| *
| * This is definitely not a brief
| */
| fun test(): String = "TODO"
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"The user token, i.e. \"Bearer xyz\". Throw an exception if not available.",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
@Test
fun `brief for functions should work with eg`() {
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|class Example(val exampleParameter: Int) {
| /**
| * The user token, e.g. "Bearer xyz". Throw an exception if not available.
| *
| * This is definitely not a brief
| */
| fun test(): String = "TODO"
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"The user token, e.g. \"Bearer xyz\". Throw an exception if not available.",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
@Test
fun `brief for functions should be first sentence for Java`() {
testInline(
"""
|/src/main/java/test/Example.java
|package test;
|
|public class Example {
| /**
| * The user token, or not. This is definitely not a brief in java
| */
| public static String test() {
| return "TODO";
| }
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"The user token, or not.",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
@Test
fun `brief for functions should work with ie for Java`() {
testInline(
"""
|/src/main/java/test/Example.java
|package test;
|
|public class Example {
| /**
| * The user token, e.g. "Bearer xyz". This is definitely not a brief in java
| */
| public static String test() {
| return "TODO";
| }
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"The user token, e.g. \"Bearer xyz\".",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
//Source: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#exampleresult
@Test
fun `brief for functions should work with html comment for Java`() {
testInline(
"""
|/src/main/java/test/Example.java
|package test;
|
|public class Example {
| /**
| * This is a simulation of Prof.<!-- --> Knuth's MIX computer. This is definitely not a brief in java
| */
| public static String test() {
| return "TODO";
| }
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"This is a simulation of Prof.<!-- --> Knuth's MIX computer.",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
@Test
fun `brief for functions should work with html comment at the end for Java`() {
testInline(
"""
|/src/main/java/test/Example.java
|package test;
|
|public class Example {
| /**
| * This is a simulation of Prof.<!-- --> Knuth's MIX computer. This is definitely not a brief in java <!-- -->
| */
| public static String test() {
| return "TODO";
| }
|}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionBriefDocs = module.singleFunctionDescription("Example")
assertEquals(
"This is a simulation of Prof.<!-- --> Knuth's MIX computer.",
functionBriefDocs.children.joinToString("") { (it as ContentText).text })
}
}
}
private fun RootPageNode.singleFunctionDescription(className: String): ContentGroup {
val classPage = dfs { it.name == className && (it as WithDocumentables).documentables.firstOrNull() is DClass } as ContentPage
val functionsTable =
classPage.content.dfs { it is ContentTable && it.dci.kind == ContentKind.Functions } as ContentTable
assertEquals(1, functionsTable.children.size)
val function = functionsTable.children.first()
return function.dfs { it is ContentGroup && it.dci.kind == ContentKind.Comment && it.children.all { it is ContentText } } as ContentGroup
}
}
|
