azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Gradle] ExternalTargetApi: Check-in/Document createCompilation

Browse Source 
KT-55524
This commit is contained in:
Sebastian Sellmair
2023-04-19 14:54:59 +02:00
committed by Space Team
parent 6e6e2977f9
commit 2ec76110b0
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/mpp/external/createExternalKotlinCompilation.kt
Vendored
+14 -2
View File
@@ -17,6 +17,17 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.decoratedInstance
import org.jetbrains.kotlin.gradle.plugin.mpp.external.ExternalDecoratedKotlinCompilation.Delegate
import org.jetbrains.kotlin.gradle.tasks.KotlinTasksProvider
/**
* Creates a compilation for External Kotlin Targets adhering to the configuration provided in the [descriptor]
* - The _kind_ of compilation will be chosen automatically by the specified [DecoratedExternalKotlinTarget.platformType]
* - The compilation will use the [ExternalKotlinCompilationDescriptor.defaultSourceSet] as its (default) source set
* - The compilation wil reference the compile task using the [ExternalKotlinCompilationDescriptor.compileTaskName] if specified
* - The compilation will reference the compile all task name using the[ExternalKotlinCompilationDescriptor.compileAllTaskName] if specified
* - Compilations .associateWith calls will be handled by the [ExternalKotlinCompilationDescriptor.compilationAssociator] if specified
* - An additional friendArtifactResolver will be respected if the [ExternalKotlinCompilationDescriptor.friendArtifactResolver] is specified
* - The [ExternalKotlinCompilationDescriptor.configure] method will be called before the compilation is available in [KotlinTarget.compilations]
* container
*/
@ExternalKotlinTargetApi
fun <T : ExternalDecoratedKotlinCompilation> DecoratedExternalKotlinTarget.createCompilation(
descriptor: ExternalKotlinCompilationDescriptor<T>
@@ -67,6 +78,9 @@ fun <T : ExternalDecoratedKotlinCompilation> DecoratedExternalKotlinTarget.creat
return decoratedCompilation
}
/**
* @see createCompilation
*/
@ExternalKotlinTargetApi
fun <T : ExternalDecoratedKotlinCompilation> DecoratedExternalKotlinTarget.createCompilation(
descriptor: ExternalKotlinCompilationDescriptorBuilder<T>.() -> Unit
@@ -74,8 +88,6 @@ fun <T : ExternalDecoratedKotlinCompilation> DecoratedExternalKotlinTarget.creat
return createCompilation(ExternalKotlinCompilationDescriptor(descriptor))
}
@OptIn(ExternalKotlinTargetApi::class)
private fun DecoratedExternalKotlinTarget.setupCompileTask(
compilation: ExternalDecoratedKotlinCompilation
) {