From 68814ccd67206cfe234ed71962a1344cfef021c2 Mon Sep 17 00:00:00 2001
From: Sebastian Sellmair <sebastian.sellmair@jetbrains.com>
Date: Wed, 10 May 2023 11:44:17 +0200
Subject: [PATCH] [Gradle] IdeDependencyResolver.WithBuildDependencies: Add
 example to doc

KT-58601
---
 .../kotlin/gradle/plugin/ide/IdeDependencyResolver.kt     | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/ide/IdeDependencyResolver.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/ide/IdeDependencyResolver.kt
index 7ad17175ff7..25a34928a28 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/ide/IdeDependencyResolver.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/ide/IdeDependencyResolver.kt
@@ -49,6 +49,14 @@ fun interface IdeDependencyResolver {
     interface WithBuildDependencies {
         /**
          * return anything accepted to be passed to [org.gradle.api.Task.dependsOn]
+         *
+         * #### Example: Resolver relying on a single task to be executed:
+         * ```kotlin
+         * object MyResolver : IdeDependencyResolver, WithBuildDependencies {
+         *     fun resolve(sourceSet: KotlinSourceSet) = // ...
+         *     fun dependencies(project: Project) = listOf(project.tasks.named("myTask"))
+         * }
+         * ```
          */
         fun dependencies(project: Project): Iterable<Any>
     }