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 <whyoleg@gmail.com>

7 files changed, 176 insertions, 0 deletions

diff --git a/dokka-subprojects/plugin-android-documentation/README.md b/dokka-subprojects/plugin-android-documentation/README.md
new file mode 100644
index 00000000..2928f180
--- /dev/null
+++ b/dokka-subprojects/plugin-android-documentation/README.md
@@ -0,0 +1,10 @@
+# Android documentation plugin
+
+The Android documentation plugin aim to improve documentation experience on the Android platform.
+
+Features:
+
+* Support for the `@hide` KDoc tag. It hides marked declaration from being displayed in documentation.
+
+You can find the Android documentation plugin on 
+[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/android-documentation-plugin).
diff --git a/dokka-subprojects/plugin-android-documentation/api/plugin-android-documentation.api b/dokka-subprojects/plugin-android-documentation/api/plugin-android-documentation.api
new file mode 100644
index 00000000..23e021a1
--- /dev/null
+++ b/dokka-subprojects/plugin-android-documentation/api/plugin-android-documentation.api
@@ -0,0 +1,11 @@
+public final class org/jetbrains/dokka/android/AndroidDocumentationPlugin : org/jetbrains/dokka/plugability/DokkaPlugin {
+	public fun <init> ()V
+	public final fun getSuppressedByHideTagDocumentableFilter ()Lorg/jetbrains/dokka/plugability/Extension;
+}
+
+public final class org/jetbrains/dokka/android/transformers/HideTagDocumentableFilter : org/jetbrains/dokka/base/transformers/documentables/SuppressedByConditionDocumentableFilterTransformer {
+	public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
+	public final fun getDokkaContext ()Lorg/jetbrains/dokka/plugability/DokkaContext;
+	public fun shouldBeSuppressed (Lorg/jetbrains/dokka/model/Documentable;)Z
+}
+
diff --git a/dokka-subprojects/plugin-android-documentation/build.gradle.kts b/dokka-subprojects/plugin-android-documentation/build.gradle.kts
new file mode 100644
index 00000000..05821e95
--- /dev/null
+++ b/dokka-subprojects/plugin-android-documentation/build.gradle.kts
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import dokkabuild.overridePublicationArtifactId
+
+plugins {
+    id("dokkabuild.kotlin-jvm")
+    id("dokkabuild.publish-jvm")
+    id("dokkabuild.test-k2")
+}
+
+overridePublicationArtifactId("android-documentation-plugin")
+
+dependencies {
+    compileOnly(projects.dokkaSubprojects.dokkaCore)
+
+    implementation(projects.dokkaSubprojects.pluginBase)
+
+    implementation(kotlin("reflect"))
+
+    testImplementation(kotlin("test"))
+    testImplementation(projects.dokkaSubprojects.pluginBase)
+    testImplementation(projects.dokkaSubprojects.coreTestApi)
+
+    symbolsTestConfiguration(project(path = ":dokka-subprojects:analysis-kotlin-symbols", configuration = "shadow"))
+    descriptorsTestConfiguration(project(path = ":dokka-subprojects:analysis-kotlin-descriptors", configuration = "shadow"))
+    testImplementation(projects.dokkaSubprojects.pluginBaseTestUtils) {
+        exclude(module = "analysis-kotlin-descriptors")
+    }
+}
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<DokkaBase>() }
+
+    public val suppressedByHideTagDocumentableFilter: Extension<PreMergeDocumentableTransformer, *, *> 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)
+            }
+        }
+    }
+
+
+}