From f988de60c30f3bab3f699520ea168d7e3b587dd8 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Tue, 18 Jul 2023 22:30:04 +0200 Subject: [PATCH] [Gradle] Document KotlinToolTask ^KT-58858 In Progress --- .../kotlin/gradle/tasks/KotlinToolTask.kt | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/tasks/KotlinToolTask.kt b/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/tasks/KotlinToolTask.kt index c9222a14269..d2b1db0c303 100644 --- a/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/tasks/KotlinToolTask.kt +++ b/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/tasks/KotlinToolTask.kt @@ -10,14 +10,34 @@ import org.gradle.api.Task import org.gradle.api.tasks.Nested import org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerToolOptions +/** + * Represents a Kotlin task performing further processing of compiled code via additional Kotlin tools using configurable [toolOptions]. + * + * Check [KotlinCommonCompilerToolOptions] inheritors (excluding [KotlinCommonCompilerToolOptions]) for possible available for configuration + * tool options. + * + * @see [KotlinCommonCompilerToolOptions] + */ interface KotlinToolTask : Task { + + /** + * Represents the tool options used by a Kotlin task with reasonable configured defaults. + * + * Could be used to either get the values of currently configured options or to modify them. + */ @get:Nested val toolOptions: TO + /** + * Configures the [toolOptions] with the provided configuration. + */ fun toolOptions(configure: TO.() -> Unit) { configure(toolOptions) } + /** + * Configures the [toolOptions] with the provided configuration. + */ fun toolOptions(configure: Action) { configure.execute(toolOptions) }