diff options
author | Vadim Mishenev <vad-mishenev@yandex.ru> | 2022-07-26 16:02:22 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-07-26 16:02:22 +0300 |
commit | 61de8f746eb0c5451f5584d6744c0925de45593f (patch) | |
tree | 8ba692b9ef668ccd4a6995fb9c1e422072d8b39e /plugins | |
parent | ddfce852a8ce8e81adc4d4ff3e9956b330965e63 (diff) | |
download | dokka-61de8f746eb0c5451f5584d6744c0925de45593f.tar.gz dokka-61de8f746eb0c5451f5584d6744c0925de45593f.tar.bz2 dokka-61de8f746eb0c5451f5584d6744c0925de45593f.zip |
Give notice of alpha version for GFM, Javadoc, Jekyll, KaJ formats (#2550)
Diffstat (limited to 'plugins')
4 files changed, 36 insertions, 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 index 78597d44..f3c44dac 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 @@ -9,6 +9,7 @@ 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 class GfmPlugin : DokkaPlugin() { @@ -38,4 +39,12 @@ class GfmPlugin : DokkaPlugin() { providing { PackageListCreator(it, RecognizedLinkFormat.DokkaGFM) } order { after(rootCreator) }) } + + 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") + } + } + } } 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 7f90f1ce..a067de84 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 @@ -14,6 +14,7 @@ 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 class JavadocPlugin : DokkaPlugin() { @@ -81,5 +82,13 @@ class JavadocPlugin : DokkaPlugin() { val deprecatedPageCreator by extending { javadocPreprocessors with DeprecatedPageCreator order { before(rootCreator) } } + + 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") + } + } + } } diff --git a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt index 4dfd21d3..2b6d646d 100644 --- a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt +++ b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt @@ -14,6 +14,7 @@ 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 class JekyllPlugin : DokkaPlugin() { @@ -47,6 +48,14 @@ class JekyllPlugin : DokkaPlugin() { val locationProvider by extending { dokkaBase.locationProviderFactory providing ::DokkaLocationProviderFactory override listOf(gfmPlugin.locationProvider) } + + 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") + } + } + } } class JekyllRenderer( diff --git a/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt b/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt index aae6f570..3c204047 100644 --- a/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt +++ b/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt @@ -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 { @@ -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") + } + } + } } |