[Gradle] KotlinTargetHierarchyBuilder: Add documentation to 'common' function
^KT-58209 Verification Pending
This commit is contained in:
committed by
Space Team
parent
52cbad2da2
commit
1d23d7de17
+18
@@ -16,6 +16,24 @@ interface KotlinTargetHierarchyBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/* Declaring groups */
|
/* Declaring groups */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shortcut for `group("common") { }`:
|
||||||
|
* Most hierarchies should attach their nodes/groups to 'common'
|
||||||
|
*
|
||||||
|
* e.g.
|
||||||
|
* ```
|
||||||
|
* common {
|
||||||
|
* group("native") {
|
||||||
|
* withIos()
|
||||||
|
* withMacos()
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* applying the shown hierarchy to the main compilations will create a 'nativeMain' source set which will
|
||||||
|
* depend on the usual 'commonMain'
|
||||||
|
*
|
||||||
|
*/
|
||||||
fun common(build: KotlinTargetHierarchyBuilder.() -> Unit) = group("common", build)
|
fun common(build: KotlinTargetHierarchyBuilder.() -> Unit) = group("common", build)
|
||||||
fun group(name: String, build: KotlinTargetHierarchyBuilder.() -> Unit = {})
|
fun group(name: String, build: KotlinTargetHierarchyBuilder.() -> Unit = {})
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user