From c01e49eec9558736959d12820361624a3c3e41e5 Mon Sep 17 00:00:00 2001
From: Marcin Aman <marcin.aman@gmail.com>
Date: Mon, 1 Mar 2021 11:57:30 +0100
Subject: Suppress tag support (#1742)

* Suppress tag support

* Support Hide tag in javadoc

* Extract hide tag to be in separate plugin
---
 .../transformers/HideTagDocumentableFilterTest.kt  | 71 ++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt

(limited to 'plugins/android-documentation/src/test')

diff --git a/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt b/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
new file mode 100644
index 00000000..01a802bf
--- /dev/null
+++ b/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
@@ -0,0 +1,71 @@
+package transformers
+
+import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.model.DClass
+import kotlin.test.assertEquals
+import org.junit.jupiter.api.Test
+
+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
+        ) {
+            documentablesFirstTransformationStep = { 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
+        ) {
+            documentablesFirstTransformationStep = { modules ->
+                val classes = modules.flatMap { it.packages }.flatMap { it.classlikes }.map { it.name }
+                assertEquals(listOf("Visible"), classes)
+            }
+        }
+    }
+
+
+}
\ No newline at end of file
-- 
cgit