Give notice of alpha version for GFM, Javadoc, Jekyll formats

Kotlin · Jun 22, 2022 · f018405 · f018405
1 parent fc86d21
commit f018405
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
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
@@ -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
@@ -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
@@ -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(