aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/test/kotlin/content
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/base/src/test/kotlin/content')
-rw-r--r--plugins/base/src/test/kotlin/content/functions/ContentForBriefTest.kt37
-rw-r--r--plugins/base/src/test/kotlin/content/typealiases/TypealiasTest.kt78
2 files changed, 115 insertions, 0 deletions
diff --git a/plugins/base/src/test/kotlin/content/functions/ContentForBriefTest.kt b/plugins/base/src/test/kotlin/content/functions/ContentForBriefTest.kt
index f86506af..c09a0e4d 100644
--- a/plugins/base/src/test/kotlin/content/functions/ContentForBriefTest.kt
+++ b/plugins/base/src/test/kotlin/content/functions/ContentForBriefTest.kt
@@ -4,6 +4,7 @@ import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.links.TypeConstructor
import org.jetbrains.dokka.model.DClass
+import org.jetbrains.dokka.model.DPackage
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.pages.*
import org.junit.jupiter.api.Assertions.assertEquals
@@ -132,6 +133,32 @@ class ContentForBriefTest : BaseAbstractTest() {
}
@Test
+ fun `brief should work for typealias`() {
+ testInline(
+ """
+ |/src/main/kotlin/test/source.kt
+ |package test
+ |
+ |/**
+ |* This is an example <!-- not visible --> of html
+ |*
+ |* This is definitely not a brief
+ |*/
+ |typealias A = Int
+ """.trimIndent(),
+ testConfiguration
+ ) {
+ pagesTransformationStage = { module ->
+ val functionBriefDocs = module.singleTypeAliasesDescription("test")
+
+ assertEquals(
+ "This is an example <!-- not visible --> of html",
+ functionBriefDocs.children.joinToString("") { (it as ContentText).text })
+ }
+ }
+ }
+
+ @Test
fun `brief for functions should work with html`() {
testInline(
"""
@@ -344,4 +371,14 @@ class ContentForBriefTest : BaseAbstractTest() {
val function = functionsTable.children.first()
return function.dfs { it is ContentGroup && it.dci.kind == ContentKind.Comment && it.children.all { it is ContentText } } as ContentGroup
}
+ private fun RootPageNode.singleTypeAliasesDescription(packageName: String): ContentGroup {
+ val packagePage =
+ dfs { it.name == packageName && (it as WithDocumentables).documentables.firstOrNull() is DPackage } as ContentPage
+ val contentTable =
+ packagePage.content.dfs { it is ContentTable && it.dci.kind == ContentKind.Classlikes } as ContentTable
+
+ assertEquals(1, contentTable.children.size)
+ val row = contentTable.children.first()
+ return row.dfs { it is ContentGroup && it.dci.kind == ContentKind.Comment && it.children.all { it is ContentText } } as ContentGroup
+ }
} \ No newline at end of file
diff --git a/plugins/base/src/test/kotlin/content/typealiases/TypealiasTest.kt b/plugins/base/src/test/kotlin/content/typealiases/TypealiasTest.kt
new file mode 100644
index 00000000..c2f58cb9
--- /dev/null
+++ b/plugins/base/src/test/kotlin/content/typealiases/TypealiasTest.kt
@@ -0,0 +1,78 @@
+package content.typealiases
+
+import matchers.content.*
+import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.model.dfs
+import org.jetbrains.dokka.pages.*
+import org.junit.jupiter.api.Test
+import utils.assertNotNull
+
+
+class TypealiasTest : BaseAbstractTest() {
+ private val configuration = dokkaConfiguration {
+ sourceSets {
+ sourceSet {
+ sourceRoots = listOf("src/")
+ classpath = listOf(commonStdlibPath!!)
+ externalDocumentationLinks = listOf(stdlibExternalDocumentationLink)
+ }
+ }
+ }
+
+ @Test
+ fun `typealias should have a dedicated page with full documentation`() {
+ testInline(
+ """
+ |/src/main/kotlin/test/Test.kt
+ |package example
+ |
+ | /**
+ | * Brief text
+ | *
+ | * some text
+ | *
+ | * @see String
+ | * @throws Unit
+ | */
+ | typealias A = String
+ """,
+ configuration
+ ) {
+ pagesTransformationStage = { module ->
+ val content = (module.dfs { it.name == "A" } as ClasslikePageNode).content
+ val platformHinted = content.dfs { it is PlatformHintedContent }
+ platformHinted.assertNotNull("platformHinted").assertNode {
+ group {
+ group {
+ group {
+ +"typealias "
+ group { group { link { +"A" } } }
+ +" = "
+ group { link { +"String" } }
+ }
+ }
+
+ group {
+ group {
+ group {
+ group { +"Brief text" }
+ group { +"some text" }
+ }
+ }
+ }
+
+ header { +"See also" }
+ table {
+ group { link { +"String" } }
+ }
+
+ header { +"Throws" }
+ table {
+ group { group { link { +"Unit" } } }
+ }
+ }
+ }
+ }
+ }
+ }
+} \ No newline at end of file