Skip to content

Commit 18fcea4

Browse files
author
yevhenii-nadtochii
committed
Give a usage example
1 parent a9de0a9 commit 18fcea4

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

buildSrc/src/main/kotlin/io/spine/dependency/Dependency.kt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,16 @@ private fun ResolutionStrategy.forceWithLogging(
117117

118118
/**
119119
* Obtains full Maven coordinates for the requested [module].
120+
*
121+
* This extension allows referencing properties of the [Dependency],
122+
* upon which it is invoked.
123+
*
124+
* An example usage:
125+
*
126+
* ```
127+
* // Supposing there is `Ksp.symbolProcessingApi: String` property declared.
128+
* Ksp.artifact { symbolProcessingApi }
129+
* ```
120130
*/
121131
fun <T : Dependency> T.artifact(module: T.() -> String): String =
122132
artifact(module())

0 commit comments

Comments
 (0)