From 5d98758645ad20269741295e5c4df22fe4c9f8b7 Mon Sep 17 00:00:00 2001
From: "Alexander.Likhachev" <Alexander.Likhachev@jetbrains.com>
Date: Tue, 30 Jan 2024 12:40:03 +0100
Subject: [PATCH] [BTA] Add KDoc for
 `CompilationService.calculateClasspathSnapshot`

---
 .../kotlin/buildtools/api/CompilationService.kt          | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/compiler/build-tools/kotlin-build-tools-api/src/main/kotlin/org/jetbrains/kotlin/buildtools/api/CompilationService.kt b/compiler/build-tools/kotlin-build-tools-api/src/main/kotlin/org/jetbrains/kotlin/buildtools/api/CompilationService.kt
index 6ca1d22cf12..9408d03bb37 100644
--- a/compiler/build-tools/kotlin-build-tools-api/src/main/kotlin/org/jetbrains/kotlin/buildtools/api/CompilationService.kt
+++ b/compiler/build-tools/kotlin-build-tools-api/src/main/kotlin/org/jetbrains/kotlin/buildtools/api/CompilationService.kt
@@ -26,7 +26,12 @@ import java.io.File
 @ExperimentalBuildToolsApi
 public interface CompilationService {
     /**
-     * TODO KT-57565
+     * Calculates JVM classpath snapshot for [classpathEntry] used for detecting changes in incremental compilation with specified [granularity].
+     *
+     * The [ClassSnapshotGranularity.CLASS_LEVEL] granularity should be preferred for rarely changing dependencies as more lightweight in terms of the resulting snapshot size.
+     *
+     * @param classpathEntry path to existent classpath entry
+     * @param granularity determines granularity of tracking.
      */
     public fun calculateClasspathSnapshot(classpathEntry: File, granularity: ClassSnapshotGranularity): ClasspathEntrySnapshot
 
@@ -57,7 +62,7 @@ public interface CompilationService {
         strategyConfig: CompilerExecutionStrategyConfiguration,
         compilationConfig: JvmCompilationConfiguration,
         sources: List<File>,
-        arguments: List<String>
+        arguments: List<String>,
     ): CompilationResult
 
     /**