From fce01457537bf90c2916c7cdd5792b91e3a0f0ed Mon Sep 17 00:00:00 2001
From: "sebastian.sellmair" <sebastian.sellmair@jetbrains.com>
Date: Tue, 8 Mar 2022 15:16:55 +0100
Subject: [PATCH] [KPM] Document IdeaKotlinDependencyEffect

KT-51386
---
 .../kotlin/gradle/kpm/idea/IdeaKotlinDependencyEffect.kt     | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyEffect.kt b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyEffect.kt
index 3e8cc2a18c9..3793a244549 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyEffect.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/kpm/idea/IdeaKotlinDependencyEffect.kt
@@ -7,6 +7,11 @@ package org.jetbrains.kotlin.gradle.kpm.idea
 
 import org.jetbrains.kotlin.gradle.plugin.mpp.pm20.KotlinGradleFragment
 
+/**
+ * An [IdeaKotlinDependencyEffect] is invoked last in the dependency resolution pipeline.
+ * It is not intended/capable of changing the resolution result, but can trigger side-effects, being sure
+ * that the dependency resolution result is final.
+ */
 fun interface IdeaKotlinDependencyEffect {
     operator fun invoke(fragment: KotlinGradleFragment, dependencies: Set<IdeaKotlinDependency>)
 }