Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from Jul 26, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36a185b
Give notice of alpha version for GFM, Javadoc, Jekyll formats
vmishenev Jun 22, 2022
c57134a
Change message of notice and add it for KaJ plugin
vmishenev Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt
View file
Open in desktop
Expand Up @@ -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() {
Expand Down Expand Up @@ -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")
}
}
}
}
9 changes: 9 additions & 0 deletions plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt
View file
Open in desktop
Expand Up @@ -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() {
Expand Down Expand Up @@ -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")
}
}
}
}

9 changes: 9 additions & 0 deletions plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
View file
Open in desktop
Expand Up @@ -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() {
Expand Down Expand Up @@ -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(
Expand Down
9 changes: 9 additions & 0 deletions plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt
View file
Open in desktop
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")
}
}
}
}