aboutsummaryrefslogtreecommitdiff
path: root/plugins/templating
diff options
context:
space:
mode:
authorVadim Mishenev <vad-mishenev@yandex.ru>2023-02-24 19:16:54 +0200
committerGitHub <noreply@github.com>2023-02-24 19:16:54 +0200
commitb730bf43d93c60df2fc3a1b0b25485b1458a9488 (patch)
tree163aca76050405db1352f73d4b8e3baa4a712c88 /plugins/templating
parent1040288ca76e070445f1400df2fcc5a56310be28 (diff)
downloaddokka-b730bf43d93c60df2fc3a1b0b25485b1458a9488.tar.gz
dokka-b730bf43d93c60df2fc3a1b0b25485b1458a9488.tar.bz2
dokka-b730bf43d93c60df2fc3a1b0b25485b1458a9488.zip
Mark Plugin Api as experimental (#2743)
Diffstat (limited to 'plugins/templating')
-rw-r--r--plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt6
-rw-r--r--plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt6
2 files changed, 12 insertions, 0 deletions
diff --git a/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt b/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt
index aea01970..aa90b548 100644
--- a/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt
+++ b/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt
@@ -3,6 +3,8 @@ package org.jetbrains.dokka.templates
import org.jetbrains.dokka.allModulesPage.templates.PackageListProcessingStrategy
import org.jetbrains.dokka.allModulesPage.templates.PagesSearchTemplateStrategy
import org.jetbrains.dokka.plugability.DokkaPlugin
+import org.jetbrains.dokka.plugability.DokkaPluginApiPreview
+import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement
import templates.ProjectNameSubstitutor
import templates.ReplaceVersionCommandHandler
import templates.SourcesetDependencyProcessingStrategy
@@ -70,4 +72,8 @@ class TemplatingPlugin : DokkaPlugin() {
val replaceVersionCommandHandler by extending {
directiveBasedCommandHandlers providing ::ReplaceVersionCommandHandler
}
+
+ @OptIn(DokkaPluginApiPreview::class)
+ override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
+ PluginApiPreviewAcknowledgement
}
diff --git a/plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt b/plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt
index 1ed961b8..eca194f3 100644
--- a/plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt
+++ b/plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt
@@ -3,6 +3,8 @@ package org.jetbrains.dokka.templates
import org.jetbrains.dokka.CoreExtensions
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.plugability.DokkaPlugin
+import org.jetbrains.dokka.plugability.DokkaPluginApiPreview
+import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement
class TestTemplatingPlugin: DokkaPlugin() {
@@ -13,4 +15,8 @@ class TestTemplatingPlugin: DokkaPlugin() {
providing ::TestTemplatingGeneration
override dokkaBase.singleGeneration)
}
+
+ @OptIn(DokkaPluginApiPreview::class)
+ override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
+ PluginApiPreviewAcknowledgement
} \ No newline at end of file