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
|
package linkableContent
import org.jetbrains.dokka.SourceLinkDefinitionImpl
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.transformers.pages.samples.DefaultSamplesTransformer
import org.jetbrains.dokka.base.transformers.pages.sourcelinks.SourceLinksTransformer
import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
import org.jetbrains.kotlin.utils.addToStdlib.cast
import org.jetbrains.kotlin.utils.addToStdlib.safeAs
import org.junit.jupiter.api.Assertions
import org.junit.jupiter.api.Test
import java.nio.file.Paths
class LinkableContentTest : AbstractCoreTest() {
@Test
fun `Include module and package documentation`() {
val testDataDir = getTestDataDir("multiplatform/basicMultiplatformTest").toAbsolutePath()
val includesDir = getTestDataDir("linkable/includes").toAbsolutePath()
val configuration = dokkaConfiguration {
passes {
pass {
moduleName = "example"
analysisPlatform = "js"
sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map {
Paths.get("$testDataDir/$it/kotlin").toString()
}
sourceSetID = "js"
includes = listOf(Paths.get("$includesDir/include2.md").toString())
}
pass {
moduleName = "example"
analysisPlatform = "jvm"
sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map {
Paths.get("$testDataDir/$it/kotlin").toString()
}
sourceSetID = "jvm"
includes = listOf(Paths.get("$includesDir/include1.md").toString())
}
}
}
testFromData(configuration) {
documentablesMergingStage = {
Assertions.assertEquals(2, it.documentation.size)
Assertions.assertEquals(2, it.packages.size)
Assertions.assertEquals(1, it.packages.first().documentation.size)
Assertions.assertEquals(1, it.packages.last().documentation.size)
}
}
}
@Test
fun `Sources multiplatform class documentation`() {
val testDataDir = getTestDataDir("linkable/sources").toAbsolutePath()
val configuration = dokkaConfiguration {
passes {
pass {
moduleName = "example"
analysisPlatform = "js"
sourceRoots = listOf("$testDataDir/jsMain/kotlin")
sourceLinks = listOf(
SourceLinkDefinitionImpl(
path = "jsMain/kotlin",
url = "https://github.com/user/repo/tree/master/src/jsMain/kotlin",
lineSuffix = "#L"
)
)
sourceSetID = "js"
}
pass {
moduleName = "example"
analysisPlatform = "jvm"
sourceRoots = listOf("$testDataDir/jvmMain/kotlin")
sourceLinks = listOf(
SourceLinkDefinitionImpl(
path = "jvmMain/kotlin",
url = "https://github.com/user/repo/tree/master/src/jvmMain/kotlin",
lineSuffix = "#L"
)
)
sourceSetID = "jvm"
}
}
}
testFromData(configuration) {
renderingStage = { rootPageNode, dokkaContext ->
val newRoot = SourceLinksTransformer(dokkaContext,
PageContentBuilder(
dokkaContext.single(dokkaContext.plugin<DokkaBase>().commentsToContentConverter),
dokkaContext.single(dokkaContext.plugin<DokkaBase>().signatureProvider),
dokkaContext.logger
)
).invoke(rootPageNode)
val moduleChildren = newRoot.children
Assertions.assertEquals(1, moduleChildren.size)
val packageChildren = moduleChildren.first().children
Assertions.assertEquals(2, packageChildren.size)
packageChildren.forEach {
val name = it.name.substringBefore("Class")
val crl = it.safeAs<ClasslikePageNode>()?.content?.safeAs<ContentGroup>()?.children?.last()
?.safeAs<ContentGroup>()?.children?.last()?.safeAs<ContentGroup>()?.children?.lastOrNull()
?.safeAs<ContentTable>()?.children?.singleOrNull()?.safeAs<ContentGroup>()?.children?.singleOrNull().safeAs<ContentResolvedLink>()
Assertions.assertEquals(
"https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3",
crl?.address
)
}
}
}
}
@Test
fun `Samples multiplatform documentation`() {
val testDataDir = getTestDataDir("linkable/samples").toAbsolutePath()
val configuration = dokkaConfiguration {
passes {
pass {
moduleName = "example"
analysisPlatform = "js"
sourceRoots = listOf("$testDataDir/jsMain/kotlin")
sourceSetID = "js"
samples = listOf("$testDataDir/jsMain/resources/Samples.kt")
}
pass {
moduleName = "example"
analysisPlatform = "jvm"
sourceRoots = listOf("$testDataDir/jvmMain/kotlin")
sourceSetID = "jvm"
samples = listOf("$testDataDir/jvmMain/resources/Samples.kt")
}
}
}
testFromData(configuration) {
renderingStage = { rootPageNode, dokkaContext ->
val newRoot = DefaultSamplesTransformer(dokkaContext).invoke(rootPageNode)
val moduleChildren = newRoot.children
Assertions.assertEquals(1, moduleChildren.size)
val packageChildren = moduleChildren.first().children
Assertions.assertEquals(2, packageChildren.size)
packageChildren.forEach {
val name = it.name.substringBefore("Class")
val classChildren = it.children
Assertions.assertEquals(2, classChildren.size)
val function = classChildren.find { it.name == "printWithExclamation" }
val text = function.cast<MemberPageNode>().content.cast<ContentGroup>().children.last()
.cast<ContentDivergentGroup>().children.single()
.cast<ContentDivergentInstance>().before
.cast<ContentGroup>().children.last()
.cast<ContentGroup>().children.last()
.cast<PlatformHintedContent>().children.single()
.cast<ContentGroup>().children.single()
.cast<ContentGroup>().children.single()
.cast<ContentCode>().children.single().cast<ContentText>().text
Assertions.assertEquals(
"${name}Class().printWithExclamation(\"Hi, $name\")",
text
)
}
}
}
}
@Test
fun `Documenting return type for a function in inner class with generic parent`(){
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|class Sample<S>(first: S){
| inner class SampleInner {
| fun foo(): S = TODO()
| }
|}
|
""".trimIndent(),
dokkaConfiguration {
passes {
pass {
sourceRoots = listOf("src/")
analysisPlatform = "jvm"
sourceSetID = "js"
}
}
}
) {
renderingStage = { module, _ ->
val sample = module.children.single { it.name == "test" }
.children.single { it.name == "Sample" }.cast<ClasslikePageNode>()
val foo = sample
.children.single { it.name == "SampleInner" }.cast<ClasslikePageNode>()
.children.single { it.name == "foo" }.cast<MemberPageNode>()
val returnTypeNode = foo.content.dfs {
val link = it.safeAs<ContentDRILink>()?.children
val child = link?.first().safeAs<ContentText>()
child?.text == "S"
}?.safeAs<ContentDRILink>()
Assertions.assertEquals(sample.dri.first(), returnTypeNode?.address)
}
}
}
}
|
