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 1 commit
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
1 change: 1 addition & 0 deletions plugins/gfm/api/gfm.api
View file
Open in desktop
Expand Up @@ -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;
Expand Down
11 changes: 11 additions & 0 deletions plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt
View file
Open in desktop
Expand Up @@ -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() {

Expand Down Expand Up @@ -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())
}
}
IgnatBeresnev marked this conversation as resolved.
Show resolved Hide resolved
}
}
1 change: 1 addition & 0 deletions plugins/javadoc/api/javadoc.api
View file
Open in desktop
Expand Up @@ -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;
Expand Down
11 changes: 11 additions & 0 deletions plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt
View file
Open in desktop
Expand Up @@ -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() {

Expand Down Expand Up @@ -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())
}
}
}
}

1 change: 1 addition & 0 deletions plugins/jekyll/api/jekyll.api
View file
Open in desktop
@@ -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;
Expand Down
11 changes: 11 additions & 0 deletions plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
View file
Open in desktop
Expand Up @@ -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() {

Expand Down Expand Up @@ -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(
Expand Down