Rename

Kotlin · Feb 24, 2023 · f9def4b · f9def4b
1 parent 13c2639
commit f9def4b
Show file tree

Hide file tree

Showing 20 changed files with 23 additions and 20 deletions.
diff --git a/core/api/core.api b/core/api/core.api
@@ -4394,9 +4394,9 @@ public abstract class org/jetbrains/dokka/plugability/DokkaPlugin {
 	protected final fun extending (Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/dokka/plugability/DokkaPlugin$ExtensionProvider;
 	protected final fun extensionPoint ()Lkotlin/properties/ReadOnlyProperty;
 	public final fun getContext ()Lorg/jetbrains/dokka/plugability/DokkaContext;
+	protected abstract fun pluginApiPreviewAcknowledgement ()Lorg/jetbrains/dokka/plugability/PluginApiPreviewAcknowledgement;
 	public final fun setContext (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
 	protected final fun unsafeInstall (Lkotlin/Lazy;)V
-	protected abstract fun warnDokkaPluginApiIsInPreviewEmptyMethod ()Lorg/jetbrains/dokka/plugability/PluginApiPreviewAcknowledgement;
 }
 
 protected final class org/jetbrains/dokka/plugability/DokkaPlugin$ExtensionProvider {

diff --git a/core/src/main/kotlin/plugability/DokkaPlugin.kt b/core/src/main/kotlin/plugability/DokkaPlugin.kt
@@ -33,8 +33,11 @@ abstract class DokkaPlugin {
     @PublishedApi
     internal var context: DokkaContext? = null
 
+    /**
+     * @see PluginApiPreviewAcknowledgement
+     */
     @DokkaPluginApiPreview
-    protected abstract fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement
+    protected abstract fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement
     protected inline fun <reified T : DokkaPlugin> plugin(): T = context?.plugin(T::class) ?: throwIllegalQuery()
 
     protected fun <T : Any> extensionPoint() = ReadOnlyProperty<DokkaPlugin, ExtensionPoint<T>> { thisRef, property ->

diff --git a/plugins/all-modules-page/src/main/kotlin/AllModulesPagePlugin.kt b/plugins/all-modules-page/src/main/kotlin/AllModulesPagePlugin.kt
@@ -49,6 +49,6 @@ class AllModulesPagePlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/android-documentation/src/main/kotlin/AndroidDocumentationPlugin.kt b/plugins/android-documentation/src/main/kotlin/AndroidDocumentationPlugin.kt
@@ -14,6 +14,6 @@ class AndroidDocumentationPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/base/base-test-utils/src/main/kotlin/utils/TestOutputWriter.kt b/plugins/base/base-test-utils/src/main/kotlin/utils/TestOutputWriter.kt
@@ -19,7 +19,7 @@ class TestOutputWriterPlugin(failOnOverwrite: Boolean = true) : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
 

diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -296,6 +296,6 @@ class DokkaBase : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/base/src/test/kotlin/model/InheritorsTest.kt b/plugins/base/src/test/kotlin/model/InheritorsTest.kt
@@ -169,7 +169,7 @@ class InheritorsTest : AbstractModelTest("/src/main/kotlin/inheritors/Test.kt",
         }
 
         @OptIn(DokkaPluginApiPreview::class)
-        override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+        override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
             PluginApiPreviewAcknowledgement
     }
     @Test

diff --git a/plugins/base/src/test/kotlin/resourceLinks/ResourceLinksTest.kt b/plugins/base/src/test/kotlin/resourceLinks/ResourceLinksTest.kt
@@ -36,7 +36,7 @@ class ResourceLinksTest : BaseAbstractTest() {
         }
 
         @OptIn(DokkaPluginApiPreview::class)
-        override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+        override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
             PluginApiPreviewAcknowledgement
     }
 

diff --git a/plugins/base/src/test/kotlin/transformerBuilders/PageTransformerBuilderTest.kt b/plugins/base/src/test/kotlin/transformerBuilders/PageTransformerBuilderTest.kt
@@ -22,7 +22,7 @@ class PageTransformerBuilderTest : BaseAbstractTest() {
         val pageTransformer by extending { CoreExtensions.pageTransformer with transformer }
 
         @OptIn(DokkaPluginApiPreview::class)
-        override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+        override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
             PluginApiPreviewAcknowledgement
     }
 

diff --git a/plugins/base/src/test/kotlin/translators/DefaultPsiToDocumentableTranslatorTest.kt b/plugins/base/src/test/kotlin/translators/DefaultPsiToDocumentableTranslatorTest.kt
@@ -331,7 +331,7 @@ class DefaultPsiToDocumentableTranslatorTest : BaseAbstractTest() {
         }
 
         @OptIn(DokkaPluginApiPreview::class)
-        override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+        override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
             PluginApiPreviewAcknowledgement
     }
 

diff --git a/...src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingPlugin.kt b/...src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingPlugin.kt
@@ -34,6 +34,6 @@ class GfmTemplateProcessingPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
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
@@ -54,6 +54,6 @@ class GfmPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
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
@@ -98,7 +98,7 @@ class JavadocPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
 
diff --git a/.../main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/JekyllTemplateProcessingPlugin.kt b/.../main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/JekyllTemplateProcessingPlugin.kt
@@ -33,6 +33,6 @@ class JekyllTemplateProcessingPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
@@ -58,7 +58,7 @@ class JekyllPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
 

diff --git a/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt b/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt
@@ -42,6 +42,6 @@ class KotlinAsJavaPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt b/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt
@@ -27,7 +27,7 @@ class MathjaxPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
 

diff --git a/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt b/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt
@@ -74,6 +74,6 @@ class TemplatingPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt b/plugins/templating/src/test/kotlin/org/jetbrains/dokka/templates/TestTemplatingPlugin.kt
@@ -17,6 +17,6 @@ class TestTemplatingPlugin: DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }
diff --git a/plugins/versioning/src/main/kotlin/org/jetbrains/dokka/versioning/VersioningPlugin.kt b/plugins/versioning/src/main/kotlin/org/jetbrains/dokka/versioning/VersioningPlugin.kt
@@ -53,6 +53,6 @@ class VersioningPlugin : DokkaPlugin() {
     }
 
     @OptIn(DokkaPluginApiPreview::class)
-    override fun warnDokkaPluginApiIsInPreviewEmptyMethod(): PluginApiPreviewAcknowledgement =
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
         PluginApiPreviewAcknowledgement
 }