blob: 2bcc0bf0adc435a07959afb98e9e7855ec3ba308 (
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
|
package markdown
import org.jetbrains.dokka.model.WithGenerics
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.pages.ClasslikePageNode
import org.jetbrains.dokka.pages.ContentDRILink
import org.jetbrains.dokka.pages.MemberPageNode
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.model.doc.DocumentationLink
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertNotNull
import org.junit.jupiter.api.Test
class LinkTest : BaseAbstractTest() {
@Test
fun linkToClassLoader() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin/parser")
}
}
}
testInline(
"""
|/src/main/kotlin/parser/Test.kt
|package parser
|
| /**
| * Some docs that link to [ClassLoader.clearAssertionStatus]
| */
|fun test(x: ClassLoader) = x.clearAssertionStatus()
|
""".trimMargin(),
configuration
) {
renderingStage = { rootPageNode, _ ->
assertNotNull((rootPageNode.children.single().children.single() as MemberPageNode)
.content
.dfs { node ->
node is ContentDRILink &&
node.address.toString() == "parser//test/#java.lang.ClassLoader/PointingToDeclaration/"}
)
}
}
}
@Test
fun returnTypeShouldHaveLinkToOuterClassFromInner() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin")
displayName = "JVM"
}
}
}
//This does not contain a package to check for situation when the package has to be artificially generated
testInline(
"""
|/src/main/kotlin/parser/Test.kt
|
|class Outer<OUTER> {
| inner class Inner<INNER> {
| fun foo(): OUTER = TODO()
| }
|}
""".trimMargin(),
configuration
) {
renderingStage = { rootPageNode, _ ->
val root = rootPageNode.children.single().children.single() as ClasslikePageNode
val innerClass = root.children.first { it is ClasslikePageNode }
val foo = innerClass.children.first { it.name == "foo" } as MemberPageNode
val destinationDri = (root.documentable as WithGenerics).generics.first().dri.toString()
assertEquals(destinationDri, "/Outer///PointingToGenericParameters(0)/")
assertNotNull(foo.content.dfs { it is ContentDRILink && it.address.toString() == destinationDri } )
}
}
}
@Test
fun `link to parameter #238`() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
testInline(
"""
|/src/main/kotlin/Test.kt
|package example
|
|/**
|* Link to [waitAMinute]
|*/
|fun stop(hammerTime: String, waitAMinute: String) {}
|
""".trimMargin(),
configuration
) {
documentablesMergingStage = { module ->
val parameter = module.dfs { it.name == "waitAMinute" }
val link = module.dfs { it.name == "stop" }!!.documentation.values.single().dfs { it is DocumentationLink } as DocumentationLink
assertEquals(parameter!!.dri, link.dri)
}
}
}
}
|
