From 352fd5356edf775a92f4e705fbce44dc7a4eddcb Mon Sep 17 00:00:00 2001 From: Sebastian Sellmair Date: Wed, 10 May 2023 17:31:54 +0200 Subject: [PATCH] [Gradle] Document IllegalStateException thrown in ExternalKotlinTargetDescriptor {} KT-58601 --- .../plugin/mpp/external/ExternalKotlinTargetDescriptor.kt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/mpp/external/ExternalKotlinTargetDescriptor.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/mpp/external/ExternalKotlinTargetDescriptor.kt index c97e6b67e50..a2c33ad6a6e 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/mpp/external/ExternalKotlinTargetDescriptor.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/mpp/external/ExternalKotlinTargetDescriptor.kt @@ -45,6 +45,13 @@ interface ExternalKotlinTargetDescriptor { * Creates a new [ExternalKotlinTargetDescriptor] using the builder pattern. * There are some required properties that have to be set. * Check [ExternalKotlinTargetDescriptorBuilder] for further details. + * + * * The following properties have to be specified: + * * - [ExternalKotlinTargetDescriptorBuilder.targetName] + * * - [ExternalKotlinTargetDescriptorBuilder.platformType] + * * - [ExternalKotlinTargetDescriptorBuilder.targetFactory] + * + * Not providing a required/necessary property will throw [IllegalStateException] */ @ExternalKotlinTargetApi fun ExternalKotlinTargetDescriptor(