aboutsummaryrefslogtreecommitdiff
path: root/dokka-subprojects/plugin-android-documentation/src/main
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-11-10 11:46:54 +0100
committerGitHub <noreply@github.com>2023-11-10 11:46:54 +0100
commit8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch)
tree1b915207b2b9f61951ddbf0ff2e687efd053d555 /dokka-subprojects/plugin-android-documentation/src/main
parenta44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff)
downloaddokka-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 'dokka-subprojects/plugin-android-documentation/src/main')
-rw-r--r--dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/AndroidDocumentationPlugin.kt26
-rw-r--r--dokka-subprojects/plugin-android-documentation/src/main/kotlin/org/jetbrains/dokka/android/transformers/HideTagDocumentableFilter.kt18
-rw-r--r--dokka-subprojects/plugin-android-documentation/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin5
3 files changed, 49 insertions, 0 deletions
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