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
|
package content.annotations
import matchers.content.*
import org.jetbrains.dokka.pages.ContentPage
import org.jetbrains.dokka.pages.PackagePageNode
import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
import org.junit.jupiter.api.Test
import utils.ParamAttributes
import utils.bareSignature
import utils.functionSignature
import utils.propertySignature
class ContentForAnnotationsTest : AbstractCoreTest() {
private val testConfiguration = dokkaConfiguration {
passes {
pass {
sourceRoots = listOf("src/")
analysisPlatform = "jvm"
targets = listOf("jvm")
}
}
}
@Test
fun `function`() {
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION,
| AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.EXPRESSION, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FIELD
|)
|@Retention(AnnotationRetention.SOURCE)
|@MustBeDocumented
|annotation class Fancy
|
|
|@Fancy
|fun function(@Fancy abc: String): String {
| return "Hello, " + abc
|}
""".trimIndent(), testConfiguration
) {
pagesTransformationStage = { module ->
val page = module.children.single { it.name == "test" }
.children.single { it.name == "function" } as ContentPage
page.content.assertNode {
group {
header(1) { +"function" }
}
divergentGroup {
divergentInstance {
divergent {
bareSignature(
mapOf("Fancy" to emptySet()),
"",
"",
emptySet(),
"function",
"String",
"abc" to ParamAttributes(mapOf("Fancy" to emptySet()), emptySet(), "String")
)
}
}
}
}
}
}
}
@Test
fun `property`() {
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|@Suppress
|val property: Int = 6
""".trimIndent(), testConfiguration
) {
pagesTransformationStage = { module ->
val page = module.children.single { it.name == "test" } as PackagePageNode
page.content.assertNode {
propertySignature(mapOf("Suppress" to setOf("names")), "", "", emptySet(), "val", "property", "Int")
}
}
}
}
@Test
fun `rich annotation`() {
testInline(
"""
|/src/main/kotlin/test/source.kt
|package test
|
|@Retention(AnnotationRetention.SOURCE)
|@Target(AnnotationTarget.FIELD)
|annotation class BugReport(
| val assignedTo: String = "[none]",
| val testCase: KClass<ABC> = ABC::class,
| val status: Status = Status.UNCONFIRMED,
| val ref: Reference = Reference(value = 1),
| val reportedBy: Array<Reference>,
| val showStopper: Boolean = false
|) {
| enum class Status {
| UNCONFIRMED, CONFIRMED, FIXED, NOTABUG
| }
| class ABC
|}
|annotation class Reference(val value: Int)
|
|
|@BugReport(
| assignedTo = "me",
| testCase = BugReport.ABC::class,
| status = BugReport.Status.FIXED,
| ref = Reference(value = 2),
| reportedBy = [Reference(value = 2), Reference(value = 4)],
| showStopper = true
|)
|val ltint: Int = 5
""".trimIndent(), testConfiguration
) {
pagesTransformationStage = { module ->
val page = module.children.single { it.name == "test" } as PackagePageNode
page.content.assertNode {
propertySignature(
mapOf(
"BugReport" to setOf(
"assignedTo",
"testCase",
"status",
"ref",
"reportedBy",
"showStopper"
)
), "", "", emptySet(), "val", "ltint", "Int"
)
}
}
}
}
}
|
