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

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

Hide file tree

Showing 6 changed files with 36 additions and 0 deletions.
diff --git a/plugins/gfm/api/gfm.api b/plugins/gfm/api/gfm.api
@@ -11,6 +11,7 @@ public final class org/jetbrains/dokka/gfm/GfmCommand$Companion {
 
 public final class org/jetbrains/dokka/gfm/GfmPlugin : org/jetbrains/dokka/plugability/DokkaPlugin {
 	public fun <init> ()V
+	public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getBriefCommentPreprocessor ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getGfmPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
 	public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension;

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/api/javadoc.api b/plugins/javadoc/api/javadoc.api
@@ -14,6 +14,7 @@ public class org/jetbrains/dokka/javadoc/JavadocPageCreator {
 public final class org/jetbrains/dokka/javadoc/JavadocPlugin : org/jetbrains/dokka/plugability/DokkaPlugin {
 	public fun <init> ()V
 	public final fun getAllClassessPageInstaller ()Lorg/jetbrains/dokka/plugability/Extension;
+	public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getDeprecatedPageCreator ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getDocumentableSourceSetFilter ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getDokkaBasePlugin ()Lorg/jetbrains/dokka/base/DokkaBase;

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/api/jekyll.api b/plugins/jekyll/api/jekyll.api
@@ -1,5 +1,6 @@
 public final class org/jetbrains/dokka/jekyll/JekyllPlugin : org/jetbrains/dokka/plugability/DokkaPlugin {
 	public fun <init> ()V
+	public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getBriefCommentPreprocessor ()Lorg/jetbrains/dokka/plugability/Extension;
 	public final fun getJekyllPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
 	public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension;

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(