From 1d23d7de170c577d4ee9b35e4d21165301e22b4b Mon Sep 17 00:00:00 2001 From: Sebastian Sellmair Date: Mon, 24 Apr 2023 14:47:21 +0200 Subject: [PATCH] [Gradle] KotlinTargetHierarchyBuilder: Add documentation to 'common' function ^KT-58209 Verification Pending --- .../plugin/KotlinTargetHierarchyBuilder.kt | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinTargetHierarchyBuilder.kt b/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinTargetHierarchyBuilder.kt index bec6a0612e1..180a5cd3aa5 100644 --- a/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinTargetHierarchyBuilder.kt +++ b/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinTargetHierarchyBuilder.kt @@ -16,6 +16,24 @@ interface KotlinTargetHierarchyBuilder { } /* 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 group(name: String, build: KotlinTargetHierarchyBuilder.() -> Unit = {})