Skip to content

Commit

Permalink
Change message of notice and add it for KaJ plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
vmishenev committed Jul 26, 2022
1 parent 36a185b commit c57134a
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
1 change: 0 additions & 1 deletion plugins/gfm/api/gfm.api
Expand Up @@ -11,7 +11,6 @@ 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;
Expand Down
12 changes: 5 additions & 7 deletions plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt
Expand Up @@ -9,9 +9,8 @@ import org.jetbrains.dokka.gfm.location.MarkdownLocationProvider
import org.jetbrains.dokka.gfm.renderer.BriefCommentPreprocessor
import org.jetbrains.dokka.gfm.renderer.CommonmarkRenderer
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.renderers.PostAction
import org.jetbrains.dokka.transformers.pages.PageTransformer
import org.jetbrains.dokka.validity.PreGenerationChecker
import org.jetbrains.dokka.validity.PreGenerationCheckerOutput

class GfmPlugin : DokkaPlugin() {

Expand Down Expand Up @@ -41,11 +40,10 @@ class GfmPlugin : DokkaPlugin() {
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())
internal val alphaVersionNotifier by extending {
CoreExtensions.postActions providing { ctx ->
PostAction {
ctx.logger.warn("GFM output format is in Alpha version, use at your own risk, expect bugs and migration issues")
}
}
}
Expand Down
1 change: 0 additions & 1 deletion plugins/javadoc/api/javadoc.api
Expand Up @@ -14,7 +14,6 @@ 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;
Expand Down
Expand Up @@ -14,9 +14,8 @@ import org.jetbrains.dokka.javadoc.transformers.documentables.JavadocDocumentabl
import org.jetbrains.dokka.javadoc.validity.MultiplatformConfiguredChecker
import org.jetbrains.dokka.kotlinAsJava.KotlinAsJavaPlugin
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.renderers.PostAction
import org.jetbrains.dokka.transformers.pages.PageTransformer
import org.jetbrains.dokka.validity.PreGenerationChecker
import org.jetbrains.dokka.validity.PreGenerationCheckerOutput

class JavadocPlugin : DokkaPlugin() {

Expand Down Expand Up @@ -84,11 +83,10 @@ class JavadocPlugin : DokkaPlugin() {
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())
internal val alphaVersionNotifier by extending {
CoreExtensions.postActions providing { ctx ->
PostAction {
ctx.logger.warn("Javadoc output format is in Alpha version, use at your own risk, expect bugs and migration issues")
}
}
}
Expand Down
1 change: 0 additions & 1 deletion plugins/jekyll/api/jekyll.api
@@ -1,6 +1,5 @@
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;
Expand Down
12 changes: 5 additions & 7 deletions plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
Expand Up @@ -14,9 +14,8 @@ import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.query
import org.jetbrains.dokka.renderers.PostAction
import org.jetbrains.dokka.transformers.pages.PageTransformer
import org.jetbrains.dokka.validity.PreGenerationChecker
import org.jetbrains.dokka.validity.PreGenerationCheckerOutput

class JekyllPlugin : DokkaPlugin() {

Expand Down Expand Up @@ -50,11 +49,10 @@ class JekyllPlugin : DokkaPlugin() {
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())
internal val alphaVersionNotifier by extending {
CoreExtensions.postActions providing { ctx ->
PostAction {
ctx.logger.warn("Jekyll output format is in Alpha version, use at your own risk, expect bugs and migration issues")
}
}
}
Expand Down
9 changes: 9 additions & 0 deletions plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt
Expand Up @@ -7,6 +7,7 @@ import org.jetbrains.dokka.kotlinAsJava.transformers.JvmNameDocumentableTransfor
import org.jetbrains.dokka.kotlinAsJava.transformers.KotlinAsJavaDocumentableTransformer
import org.jetbrains.dokka.kotlinAsJava.translators.KotlinAsJavaDocumentableToPageTranslator
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.renderers.PostAction

class KotlinAsJavaPlugin : DokkaPlugin() {
val kotlinAsJavaDocumentableTransformer by extending {
Expand All @@ -29,4 +30,12 @@ class KotlinAsJavaPlugin : DokkaPlugin() {
CoreExtensions.documentableToPageTranslator providing ::KotlinAsJavaDocumentableToPageTranslator override
plugin<DokkaBase>().documentableToPageTranslator
}

internal val alphaVersionNotifier by extending {
CoreExtensions.postActions providing { ctx ->
PostAction {
ctx.logger.warn("KotlinAsJava plugin is in Alpha version, use at your own risk, expect bugs and migration issues")
}
}
}
}

0 comments on commit c57134a

Please sign in to comment.