Add an opt-in requirement for DokkaPublication#finalizeCoroutines (#3868

) KT-72288
Kotlin · Oct 31, 2024 · 2ed83e5 · 2ed83e5
1 parent af05202
commit 2ed83e5
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api b/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api
@@ -243,7 +243,6 @@ public abstract class org/jetbrains/dokka/gradle/engine/parameters/DokkaExternal
 public abstract class org/jetbrains/dokka/gradle/engine/parameters/DokkaGeneratorParametersSpec : org/gradle/api/plugins/ExtensionAware {
 	public final fun getDokkaSourceSets ()Lorg/gradle/api/NamedDomainObjectContainer;
 	public abstract fun getFailOnWarning ()Lorg/gradle/api/provider/Property;
-	public abstract fun getFinalizeCoroutines ()Lorg/gradle/api/provider/Property;
 	public abstract fun getIncludes ()Lorg/gradle/api/file/ConfigurableFileCollection;
 	public abstract fun getModuleName ()Lorg/gradle/api/provider/Property;
 	public abstract fun getModuleOutputDirectories ()Lorg/gradle/api/file/ConfigurableFileCollection;
@@ -508,7 +507,6 @@ public abstract class org/jetbrains/dokka/gradle/formats/DokkaPublication : java
 	public abstract fun getCacheRoot ()Lorg/gradle/api/file/DirectoryProperty;
 	public abstract fun getEnabled ()Lorg/gradle/api/provider/Property;
 	public abstract fun getFailOnWarning ()Lorg/gradle/api/provider/Property;
-	public abstract fun getFinalizeCoroutines ()Lorg/gradle/api/provider/Property;
 	public final fun getFormatName ()Ljava/lang/String;
 	public abstract fun getIncludes ()Lorg/gradle/api/file/ConfigurableFileCollection;
 	public abstract fun getModuleName ()Lorg/gradle/api/provider/Property;

diff --git a/...ers/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaGeneratorParametersSpec.kt b/...ers/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaGeneratorParametersSpec.kt
@@ -10,8 +10,8 @@ import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.*
 import org.gradle.api.tasks.PathSensitivity.RELATIVE
-import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi
 import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer
+import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi
 import org.jetbrains.dokka.gradle.internal.adding
 import org.jetbrains.dokka.gradle.internal.domainObjectContainer
 import javax.inject.Inject
@@ -94,6 +94,7 @@ constructor(
     abstract val moduleOutputDirectories: ConfigurableFileCollection
 
     /** @see org.jetbrains.dokka.gradle.formats.DokkaPublication.finalizeCoroutines */
+    @InternalDokkaGradlePluginApi
     @get:Input
     abstract val finalizeCoroutines: Property<Boolean>
 }
diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaPublication.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaPublication.kt
@@ -9,8 +9,8 @@ import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.provider.Property
 import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
-import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi
 import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer
+import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi
 import org.jetbrains.dokka.gradle.internal.adding
 import java.io.Serializable
 import javax.inject.Inject
@@ -149,6 +149,7 @@ constructor(
      * This is an internal Dokka Gradle plugin property.
      * If you find you need to set this property, please report your use-case https://kotl.in/dokka-issues.
      */
+    @InternalDokkaGradlePluginApi
     abstract val finalizeCoroutines: Property<Boolean>
 
     /**