From e2d61e7f9428bd4e451df1ae9585deb12469487f Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Tue, 8 Mar 2022 15:23:16 +0100 Subject: [PATCH] [KPM] Document IdeaKotlinDependencyTransformer KT-51386 --- .../gradle/kpm/idea/IdeaKotlinDependencyTransformer.kt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyTransformer.kt b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyTransformer.kt index 3299d71da2b..f1aff20b89e 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyTransformer.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyTransformer.kt @@ -7,6 +7,14 @@ package org.jetbrains.kotlin.gradle.kpm.idea import org.jetbrains.kotlin.gradle.plugin.mpp.pm20.KotlinGradleFragment +/** + * An [IdeaKotlinDependencyTransformer] will be invoked after all [IdeaKotlinDependencyResolver] finished. + * The transformation step is allowed to entirely modify the resolution result. Typical applications would be dependency filtering, + * or grouping. Adding additional dependencies might be harmful, since other transformers might not be able to see this additional + * dependency, running before the addition. + * + * Transformations can be scheduled in different phases see: [IdeaKotlinProjectModelBuilder.DependencyTransformationPhase] + */ fun interface IdeaKotlinDependencyTransformer { fun transform( fragment: KotlinGradleFragment, dependencies: Set