diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /plugins/android-documentation | |
parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
download | dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2 dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip |
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>
Diffstat (limited to 'plugins/android-documentation')
7 files changed, 0 insertions, 178 deletions
diff --git a/plugins/android-documentation/README.md b/plugins/android-documentation/README.md deleted file mode 100644 index 2928f180..00000000 --- a/plugins/android-documentation/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# 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/plugins/android-documentation/api/android-documentation.api b/plugins/android-documentation/api/android-documentation.api deleted file mode 100644 index 23e021a1..00000000 --- a/plugins/android-documentation/api/android-documentation.api +++ /dev/null @@ -1,11 +0,0 @@ -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/plugins/android-documentation/build.gradle.kts b/plugins/android-documentation/build.gradle.kts deleted file mode 100644 index 66a12837..00000000 --- a/plugins/android-documentation/build.gradle.kts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. - */ - -import org.jetbrains.registerDokkaArtifactPublication - -plugins { - id("org.jetbrains.conventions.kotlin-jvm") - id("org.jetbrains.conventions.maven-publish") - id("org.jetbrains.conventions.base-unit-test") -} - -dependencies { - compileOnly(projects.core) - - implementation(projects.plugins.base) - - implementation(kotlin("reflect")) - - testImplementation(kotlin("test")) - testImplementation(projects.plugins.base) - testImplementation(projects.core.testApi) - - symbolsTestConfiguration(project(path = ":subprojects:analysis-kotlin-symbols", configuration = "shadow")) - descriptorsTestConfiguration(project(path = ":subprojects:analysis-kotlin-descriptors", configuration = "shadow")) - testImplementation(projects.plugins.base.baseTestUtils) { - exclude(module = "analysis-kotlin-descriptors") - } -} - -registerDokkaArtifactPublication("androidDocumentationPlugin") { - artifactId = "android-documentation-plugin" -} diff --git a/plugins/android-documentation/src/main/kotlin/AndroidDocumentationPlugin.kt b/plugins/android-documentation/src/main/kotlin/AndroidDocumentationPlugin.kt deleted file mode 100644 index 089a19a4..00000000 --- a/plugins/android-documentation/src/main/kotlin/AndroidDocumentationPlugin.kt +++ /dev/null @@ -1,26 +0,0 @@ -/* - * 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/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt b/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt deleted file mode 100644 index ec05efc5..00000000 --- a/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt +++ /dev/null @@ -1,18 +0,0 @@ -/* - * 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/plugins/android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/plugins/android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin deleted file mode 100644 index ee64db6b..00000000 --- a/plugins/android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin +++ /dev/null @@ -1,5 +0,0 @@ -# -# 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/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt b/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt deleted file mode 100644 index e461755d..00000000 --- a/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt +++ /dev/null @@ -1,75 +0,0 @@ -/* - * 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) - } - } - } - - -} |