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
|
package org.jetbrains.dokka.javadoc
import com.sun.javadoc.Tag
import com.sun.javadoc.Type
import org.jetbrains.dokka.DokkaConsoleLogger
import org.jetbrains.dokka.Platform
import org.jetbrains.dokka.tests.ModelConfig
import org.jetbrains.dokka.tests.assertEqualsIgnoringSeparators
import org.jetbrains.dokka.tests.checkSourceExistsAndVerifyModel
import org.junit.Assert.*
import org.junit.Test
class JavadocTest {
val defaultModelConfig = ModelConfig(analysisPlatform = Platform.jvm)
@Test fun testTypes() {
verifyJavadoc("testdata/javadoc/types.kt", ModelConfig(analysisPlatform = Platform.jvm, withJdk = true)) { doc ->
val classDoc = doc.classNamed("foo.TypesKt")!!
val method = classDoc.methods().find { it.name() == "foo" }!!
val type = method.returnType()
assertFalse(type.asClassDoc().isIncluded)
assertEquals("java.lang.String", type.qualifiedTypeName())
assertEquals("java.lang.String", type.asClassDoc().qualifiedName())
val params = method.parameters()
assertTrue(params[0].type().isPrimitive)
assertFalse(params[1].type().asClassDoc().isIncluded)
}
}
@Test fun testObject() {
verifyJavadoc("testdata/javadoc/obj.kt", defaultModelConfig) { doc ->
val classDoc = doc.classNamed("foo.O")
assertNotNull(classDoc)
val companionDoc = doc.classNamed("foo.O.Companion")
assertNotNull(companionDoc)
val pkgDoc = doc.packageNamed("foo")!!
assertEquals(2, pkgDoc.allClasses().size)
}
}
@Test fun testException() {
verifyJavadoc(
"testdata/javadoc/exception.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val classDoc = doc.classNamed("foo.MyException")!!
val member = classDoc.methods().find { it.name() == "foo" }
assertEquals(classDoc, member!!.containingClass())
}
}
@Test fun testByteArray() {
verifyJavadoc(
"testdata/javadoc/bytearr.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val classDoc = doc.classNamed("foo.ByteArray")!!
assertNotNull(classDoc.asClassDoc())
val member = classDoc.methods().find { it.name() == "foo" }!!
assertEquals("[]", member.returnType().dimension())
}
}
@Test fun testStringArray() {
verifyJavadoc(
"testdata/javadoc/stringarr.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val classDoc = doc.classNamed("foo.Foo")!!
assertNotNull(classDoc.asClassDoc())
val member = classDoc.methods().find { it.name() == "main" }!!
val paramType = member.parameters()[0].type()
assertNull(paramType.asParameterizedType())
assertEquals("String", paramType.typeName())
assertEquals("String", paramType.asClassDoc().name())
}
}
@Test fun testJvmName() {
verifyJavadoc(
"testdata/javadoc/jvmname.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val classDoc = doc.classNamed("foo.Apple")!!
assertNotNull(classDoc.asClassDoc())
val member = classDoc.methods().find { it.name() == "_tree" }
assertNotNull(member)
}
}
@Test fun testLinkWithParam() {
verifyJavadoc(
"testdata/javadoc/paramlink.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val classDoc = doc.classNamed("demo.Apple")!!
assertNotNull(classDoc.asClassDoc())
val tags = classDoc.inlineTags().filterIsInstance<SeeTagAdapter>()
assertEquals(2, tags.size)
val linkTag = tags[1] as SeeMethodTagAdapter
assertEquals("cutIntoPieces", linkTag.method.name())
}
}
@Test fun testInternalVisibility() {
verifyJavadoc(
"testdata/javadoc/internal.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true, includeNonPublic = false)
) { doc ->
val classDoc = doc.classNamed("foo.Person")!!
val constructors = classDoc.constructors()
assertEquals(1, constructors.size)
assertEquals(1, constructors.single().parameters().size)
}
}
@Test fun testSuppress() {
verifyJavadoc(
"testdata/javadoc/suppress.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
assertNull(doc.classNamed("Some"))
assertNull(doc.classNamed("SomeAgain"))
assertNull(doc.classNamed("Interface"))
val classSame = doc.classNamed("Same")!!
assertTrue(classSame.fields().isEmpty())
assertTrue(classSame.methods().isEmpty())
}
}
@Test fun testTypeAliases() {
verifyJavadoc(
"testdata/javadoc/typealiases.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
assertNull(doc.classNamed("B"))
assertNull(doc.classNamed("D"))
assertEquals("A", doc.classNamed("C")!!.superclass().name())
val methodParamType = doc.classNamed("TypealiasesKt")!!.methods()
.find { it.name() == "some" }!!.parameters().first()
.type()
assertEquals("kotlin.jvm.functions.Function1", methodParamType.qualifiedTypeName())
assertEquals("? super A, C", methodParamType.asParameterizedType().typeArguments()
.map(Type::qualifiedTypeName).joinToString())
}
}
@Test fun testKDocKeywordsOnMethod() {
verifyJavadoc(
"testdata/javadoc/kdocKeywordsOnMethod.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val method = doc.classNamed("KdocKeywordsOnMethodKt")!!.methods()[0]
assertEquals("@return [ContentText(text=value of a)]", method.tags("return").first().text())
assertEquals("@param a [ContentText(text=Some string)]", method.paramTags().first().text())
assertEquals("@throws FireException [ContentText(text=in case of fire)]", method.throwsTags().first().text())
}
}
@Test
fun testBlankLineInsideCodeBlock() {
verifyJavadoc(
"testdata/javadoc/blankLineInsideCodeBlock.kt",
ModelConfig(analysisPlatform = Platform.jvm, withKotlinRuntime = true)
) { doc ->
val method = doc.classNamed("BlankLineInsideCodeBlockKt")!!.methods()[0]
val text = method.inlineTags().joinToString(separator = "", transform = Tag::text)
assertEqualsIgnoringSeparators("""
<p><code><pre>
This is a test
of Dokka's code blocks.
Here is a blank line.
The previous line was blank.
</pre></code></p>
""".trimIndent(), text)
}
}
@Test
fun testCompanionMethodReference() {
verifyJavadoc("testdata/javadoc/companionMethodReference.kt", defaultModelConfig) { doc ->
val classDoc = doc.classNamed("foo.TestClass")!!
val tag = classDoc.inlineTags().filterIsInstance<SeeMethodTagAdapter>().first()
assertEquals("TestClass.Companion", tag.referencedClassName())
assertEquals("test", tag.referencedMemberName())
}
}
private fun verifyJavadoc(name: String,
modelConfig: ModelConfig = ModelConfig(),
callback: (ModuleNodeAdapter) -> Unit) {
checkSourceExistsAndVerifyModel(name,
ModelConfig(
analysisPlatform = Platform.jvm,
format = "javadoc",
withJdk = modelConfig.withJdk,
withKotlinRuntime = modelConfig.withKotlinRuntime,
includeNonPublic = modelConfig.includeNonPublic
)) { model ->
val doc = ModuleNodeAdapter(model, StandardReporter(DokkaConsoleLogger), "")
callback(doc)
}
}
}
|
