From 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Fri, 10 Nov 2023 11:46:54 +0100 Subject: Restructure the project to utilize included builds (#3174) * Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich --- .../dokka/android/AndroidDocumentationPlugin.kt | 26 ++++++++ .../transformers/HideTagDocumentableFilter.kt | 18 ++++++ .../org.jetbrains.dokka.plugability.DokkaPlugin | 5 ++ .../transformers/HideTagDocumentableFilterTest.kt | 75 ++++++++++++++++++++++ 4 files changed, 124 insertions(+) create mode 100644 dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/AndroidDocumentationPlugin.kt create mode 100644 dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/transformers/HideTagDocumentableFilter.kt create mode 100644 dokka-subprojects/plugin-android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin create mode 100644 dokka-subprojects/plugin-android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt (limited to 'dokka-subprojects/plugin-android-documentation/src') diff --git a/dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/AndroidDocumentationPlugin.kt b/dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/AndroidDocumentationPlugin.kt new file mode 100644 index 00000000..089a19a4 --- /dev/null +++ b/dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/AndroidDocumentationPlugin.kt @@ -0,0 +1,26 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + +package org.jetbrains.dokka.android + +import org.jetbrains.dokka.android.transformers.HideTagDocumentableFilter +import org.jetbrains.dokka.base.DokkaBase +import org.jetbrains.dokka.plugability.DokkaPlugin +import org.jetbrains.dokka.plugability.DokkaPluginApiPreview +import org.jetbrains.dokka.plugability.Extension +import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement +import org.jetbrains.dokka.transformers.documentation.PreMergeDocumentableTransformer + +public class AndroidDocumentationPlugin : DokkaPlugin() { + + private val dokkaBase by lazy { plugin() } + + public val suppressedByHideTagDocumentableFilter: Extension by extending { + dokkaBase.preMergeDocumentableTransformer providing ::HideTagDocumentableFilter order { before(dokkaBase.emptyPackagesFilter) } + } + + @OptIn(DokkaPluginApiPreview::class) + override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement = + PluginApiPreviewAcknowledgement +} diff --git a/dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/transformers/HideTagDocumentableFilter.kt b/dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/transformers/HideTagDocumentableFilter.kt new file mode 100644 index 00000000..ec05efc5 --- /dev/null +++ b/dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/transformers/HideTagDocumentableFilter.kt @@ -0,0 +1,18 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + +package org.jetbrains.dokka.android.transformers + +import org.jetbrains.dokka.base.transformers.documentables.SuppressedByConditionDocumentableFilterTransformer +import org.jetbrains.dokka.model.Documentable +import org.jetbrains.dokka.model.dfs +import org.jetbrains.dokka.model.doc.CustomTagWrapper +import org.jetbrains.dokka.plugability.DokkaContext + +public class HideTagDocumentableFilter(public val dokkaContext: DokkaContext) : + SuppressedByConditionDocumentableFilterTransformer(dokkaContext) { + + override fun shouldBeSuppressed(d: Documentable): Boolean = + d.documentation.any { (_, docs) -> docs.dfs { it is CustomTagWrapper && it.name.trim() == "hide" } != null } +} diff --git a/dokka-subprojects/plugin-android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/dokka-subprojects/plugin-android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin new file mode 100644 index 00000000..ee64db6b --- /dev/null +++ b/dokka-subprojects/plugin-android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin @@ -0,0 +1,5 @@ +# +# Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. +# + +org.jetbrains.dokka.android.AndroidDocumentationPlugin 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) + } + } + } + + +} -- cgit