From f018405e6ab5cf265dd2b628af4f94c22ad320e1 Mon Sep 17 00:00:00 2001 From: vmishenev Date: Wed, 22 Jun 2022 15:15:35 +0300 Subject: [PATCH] Give notice of alpha version for GFM, Javadoc, Jekyll formats --- .../main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt | 11 +++++++++++ .../org/jetbrains/dokka/javadoc/JavadocPlugin.kt | 11 +++++++++++ plugins/jekyll/src/main/kotlin/JekyllPlugin.kt | 11 +++++++++++ 3 files changed, 33 insertions(+) diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt index 78597d445e..c8951c5502 100644 --- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt +++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt @@ -10,6 +10,8 @@ import org.jetbrains.dokka.gfm.renderer.BriefCommentPreprocessor import org.jetbrains.dokka.gfm.renderer.CommonmarkRenderer import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.dokka.validity.PreGenerationChecker +import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class GfmPlugin : DokkaPlugin() { @@ -38,4 +40,13 @@ class GfmPlugin : DokkaPlugin() { providing { PackageListCreator(it, RecognizedLinkFormat.DokkaGFM) } order { after(rootCreator) }) } + + val alphaVersionNotifier by extending { + CoreExtensions.preGenerationCheck providing { ctx -> + PreGenerationChecker { + ctx.logger.warn("The GFM output format is in Alpha version") + PreGenerationCheckerOutput(true, emptyList()) + } + } + } } diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt index 7f90f1ce15..1c8f67dd64 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt @@ -15,6 +15,8 @@ import org.jetbrains.dokka.javadoc.validity.MultiplatformConfiguredChecker import org.jetbrains.dokka.kotlinAsJava.KotlinAsJavaPlugin import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.dokka.validity.PreGenerationChecker +import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class JavadocPlugin : DokkaPlugin() { @@ -81,5 +83,14 @@ class JavadocPlugin : DokkaPlugin() { val deprecatedPageCreator by extending { javadocPreprocessors with DeprecatedPageCreator order { before(rootCreator) } } + + val alphaVersionNotifier by extending { + CoreExtensions.preGenerationCheck providing { ctx -> + PreGenerationChecker { + ctx.logger.warn("The Javadoc output format is in Alpha version") + PreGenerationCheckerOutput(true, emptyList()) + } + } + } } diff --git a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt index 4dfd21d36a..7bfcbc2ae0 100644 --- a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt +++ b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt @@ -15,6 +15,8 @@ import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.plugability.plugin import org.jetbrains.dokka.plugability.query import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.dokka.validity.PreGenerationChecker +import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class JekyllPlugin : DokkaPlugin() { @@ -47,6 +49,15 @@ class JekyllPlugin : DokkaPlugin() { val locationProvider by extending { dokkaBase.locationProviderFactory providing ::DokkaLocationProviderFactory override listOf(gfmPlugin.locationProvider) } + + val alphaVersionNotifier by extending { + CoreExtensions.preGenerationCheck providing { ctx -> + PreGenerationChecker { + ctx.logger.warn("The Jekyll output format is in Alpha version") + PreGenerationCheckerOutput(true, emptyList()) + } + } + } } class JekyllRenderer(