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
|
package translators
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.Annotations
import org.jetbrains.dokka.model.TypeConstructor
import org.jetbrains.dokka.model.doc.Text
import org.jetbrains.dokka.model.firstMemberOfType
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test
import utils.assertNotNull
class DefaultPsiToDocumentableTranslatorTest : BaseAbstractTest() {
@Suppress("DEPRECATION") // for includeNonPublic
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/java")
includeNonPublic = true
}
}
}
@Test
fun `method overriding two documented classes picks closest class documentation`() {
testInline(
"""
|/src/main/java/sample/BaseClass1.java
|package sample;
|public class BaseClass1 {
| /** B1 */
| void x() { }
|}
|
|/src/main/java/sample/BaseClass2.java
|package sample;
|public class BaseClass2 extends BaseClass1 {
| /** B2 */
| void x() { }
|}
|
|/src/main/java/sample/X.java
|package sample;
|public class X extends BaseClass2 {
| void x() { }
|}
""".trimIndent(),
configuration
) {
documentablesMergingStage = { module ->
val documentationOfFunctionX = module.documentationOf("X", "x")
assertTrue(
"B2" in documentationOfFunctionX,
"Expected nearest super method documentation to be parsed as documentation. " +
"Documentation: $documentationOfFunctionX"
)
}
}
}
@Test
fun `method overriding class and interface picks class documentation`() {
testInline(
"""
|/src/main/java/sample/BaseClass1.java
|package sample;
|public class BaseClass1 {
| /** B1 */
| void x() { }
|}
|
|/src/main/java/sample/Interface1.java
|package sample;
|public interface Interface1 {
| /** I1 */
| void x() {}
|}
|
|/src/main/java/sample/X.java
|package sample;
|public class X extends BaseClass1 implements Interface1 {
| void x() { }
|}
""".trimMargin(),
configuration
) {
documentablesMergingStage = { module ->
val documentationOfFunctionX = module.documentationOf("X", "x")
assertTrue(
"B1" in documentationOfFunctionX,
"Expected documentation of superclass being prioritized over interface " +
"Documentation: $documentationOfFunctionX"
)
}
}
}
@Test
fun `method overriding two classes picks closest documented class documentation`() {
testInline(
"""
|/src/main/java/sample/BaseClass1.java
|package sample;
|public class BaseClass1 {
| /** B1 */
| void x() { }
|}
|
|/src/main/java/sample/BaseClass2.java
|package sample;
|public class BaseClass2 extends BaseClass1 {
| void x() {}
|}
|
|/src/main/java/sample/X.java
|package sample;
|public class X extends BaseClass2 {
| void x() { }
|}
""".trimMargin(),
configuration
) {
documentablesMergingStage = { module ->
val documentationOfFunctionX = module.documentationOf("X", "x")
assertTrue(
"B1" in documentationOfFunctionX,
"Expected Documentation \"B1\", found: \"$documentationOfFunctionX\""
)
}
}
}
@Test
fun `java package-info package description`() {
testInline(
"""
|/src/main/java/sample/BaseClass1.java
|package sample;
|public class BaseClass1 {
| /** B1 */
| void x() { }
|}
|
|/src/main/java/sample/BaseClass2.java
|package sample;
|public class BaseClass2 extends BaseClass1 {
| void x() {}
|}
|
|/src/main/java/sample/X.java
|package sample;
|public class X extends BaseClass2 {
| void x() { }
|}
|
|/src/main/java/sample/package-info.java
|/**
| * Here comes description from package-info
| */
|package sample;
""".trimMargin(),
configuration
) {
documentablesMergingStage = { module ->
val documentationOfPackage = module.packages.single().documentation.values.single().children.single()
.firstMemberOfType<Text>().body
assertEquals(
"Here comes description from package-info", documentationOfPackage
)
}
}
}
@Test
fun `java package-info package annotations`() {
testInline(
"""
|/src/main/java/sample/PackageAnnotation.java
|package sample;
|@java.lang.annotation.Target(java.lang.annotation.ElementType.PACKAGE)
|public @interface PackageAnnotation {
|}
|
|/src/main/java/sample/package-info.java
|@PackageAnnotation
|package sample;
""".trimMargin(),
configuration
) {
documentablesMergingStage = { module ->
assertEquals(
Annotations.Annotation(DRI("sample", "PackageAnnotation"), emptyMap()),
module.packages.single().extra[Annotations]?.directAnnotations?.values?.single()?.single()
)
}
}
}
class OnlyPsiPlugin : DokkaPlugin() {
private val dokkaBase by lazy { plugin<DokkaBase>() }
@Suppress("unused")
val psiOverrideDescriptorTranslator by extending {
(dokkaBase.psiToDocumentableTranslator
override dokkaBase.descriptorToDocumentableTranslator)
}
}
// for Kotlin classes from DefaultPsiToDocumentableTranslator
@Test
fun `should resolve ultralight class`() {
val configurationWithNoJVM = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/java")
}
}
}
testInline(
"""
|/src/main/java/example/Test.kt
|package example
|
|open class KotlinSubClass {
| fun kotlinSubclassFunction(bar: String): String {
| return "KotlinSubClass"
| }
|}
|
|/src/main/java/example/JavaLeafClass.java
|package example;
|
|public class JavaLeafClass extends KotlinSubClass {
| public String javaLeafClassFunction(String baz) {
| return "JavaLeafClass";
| }
|}
""".trimMargin(),
configurationWithNoJVM,
pluginOverrides = listOf(OnlyPsiPlugin()) // suppress a descriptor translator because of psi and descriptor translators work in parallel
) {
documentablesMergingStage = { module ->
val kotlinSubclassFunction =
module.packages.single().classlikes.find { it.name == "JavaLeafClass" }?.functions?.find { it.name == "kotlinSubclassFunction" }
.assertNotNull("kotlinSubclassFunction ")
assertEquals(
"String",
(kotlinSubclassFunction.type as? TypeConstructor)?.dri?.classNames
)
assertEquals(
"String",
(kotlinSubclassFunction.parameters.firstOrNull()?.type as? TypeConstructor)?.dri?.classNames
)
}
}
}
}
|
