aboutsummaryrefslogtreecommitdiff
path: root/dokka-subprojects/plugin-android-documentation/src/test/kotlin
diff options
context:
space:
mode:
Diffstat (limited to 'dokka-subprojects/plugin-android-documentation/src/test/kotlin')
-rw-r--r--dokka-subprojects/plugin-android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt75
1 files changed, 75 insertions, 0 deletions
diff --git a/dokka-subprojects/plugin-android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt b/dokka-subprojects/plugin-android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
new file mode 100644
index 00000000..e461755d
--- /dev/null
+++ b/dokka-subprojects/plugin-android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package transformers
+
+import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.model.DClass
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class HideTagDocumentableFilterTest : BaseAbstractTest() {
+ private val configuration = dokkaConfiguration {
+ sourceSets {
+ sourceSet {
+ sourceRoots = listOf("src")
+ }
+ }
+ }
+
+
+ @Test
+ fun `should work as hide in java with functions`() {
+ testInline(
+ """
+ |/src/suppressed/Testing.java
+ |package testing;
+ |
+ |public class Testing {
+ | /**
+ | * @hide
+ | */
+ | public void shouldNotBeVisible() { }
+ |}
+ """.trimIndent(), configuration
+ ) {
+ preMergeDocumentablesTransformationStage = { modules ->
+ val testingClass = modules.flatMap { it.packages }.flatMap { it.classlikes }.single() as DClass
+ assertEquals(0, testingClass.functions.size)
+ }
+ }
+ }
+
+ @Test
+ fun `should work as hide in java with classes`() {
+ testInline(
+ """
+ |/src/suppressed/Suppressed.java
+ |package testing;
+ |
+ |/**
+ | * @hide
+ | */
+ |public class Suppressed {
+ |}
+ |/src/suppressed/Visible.java
+ |package testing;
+ |
+ |/**
+ | * Another docs
+ | * @undeprecate
+ | */
+ |public class Visible {
+ |}
+ """.trimIndent(), configuration
+ ) {
+ preMergeDocumentablesTransformationStage = { modules ->
+ val classes = modules.flatMap { it.packages }.flatMap { it.classlikes }.map { it.name }
+ assertEquals(listOf("Visible"), classes)
+ }
+ }
+ }
+
+
+}