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

[Gradle] Document IdeAdditionalArtifactResolver.resolve...

Browse Source 
... providing the contract of the function as well as further clarifying
on the term 'additional artifact'

KT-58601
This commit is contained in:
Sebastian Sellmair
2023-05-10 11:23:55 +02:00
committed by Space Team
parent 34db304ef7
commit df8b098cc0
1 changed files with 15 additions and 0 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/ide/IdeAdditionalArtifactResolver.kt
+15
View File
@@ -28,6 +28,21 @@ import org.jetbrains.kotlin.gradle.plugin.ide.IdeDependencyResolver.Companion.SO
*/
@ExternalKotlinTargetApi
fun interface IdeAdditionalArtifactResolver {
/**
* This function is intended to resolve 'additional' artifacts:
* This means 'artifacts' that can be attached to some existing/already resolved dependency.
* One good example of such an 'additional artifact' would be a -sources.jar file:
* It is not a dependency on its own: It shares the coordinates with some [IdeaKotlinBinaryDependency] and can be
* attached to this dependency to provide extra functionality.
*
* Contract:
* - This function is allowed to attach data to a given [IdeaKotlinDependency]
* - This function is not allowed to remove data from a given [IdeaKotlinBinaryDependency]
* - This function is not supposed to modify the [sourceSet]
*
* @param sourceSet: The current SourceSet which shall resolve additional dependencies
* @param dependencies: The already resolved dependencies from prior stages
*/
fun resolve(sourceSet: KotlinSourceSet, dependencies: Set<IdeaKotlinDependency>)
@ExternalKotlinTargetApi