From fcb2b0475ef7e1f271cd2541509f48ce6122c855 Mon Sep 17 00:00:00 2001
From: Yan Zhulanow <yan.zhulanow@jetbrains.com>
Date: Wed, 26 Jul 2023 22:21:33 +0900
Subject: [PATCH] [Analysis API] Improve documentation for
 'KtCompilationResult'

---
 .../kotlin/analysis/api/components/KtCompilerFacility.kt   | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/components/KtCompilerFacility.kt b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/components/KtCompilerFacility.kt
index c84f5b51426..9dd3af35a6d 100644
--- a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/components/KtCompilerFacility.kt
+++ b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/components/KtCompilerFacility.kt
@@ -16,7 +16,10 @@ import org.jetbrains.kotlin.psi.KtCodeFragment
 import java.io.File
 
 /**
- * Compilation result.
+ * In-memory compilation result returned from [KtCompilerFacility].
+ *
+ * Compilation fails if there are critical errors reported either on the frontend or on the backend side.
+ * Keep in mind that [KtCompilationResult] is a part of Analysis API, so it should only be used inside an analysis block.
  */
 public sealed class KtCompilationResult {
     /**
@@ -77,7 +80,7 @@ public abstract class KtCompilerFacility : KtAnalysisSessionComponent() {
 
 public interface KtCompilerFacilityMixIn : KtAnalysisSessionMixIn {
     /**
-     * Compile the given [file].
+     * Compile the given [file] in-memory (without dumping the compiled binaries to a disk).
      *
      * @param file A file to compile.
      *  The file must be either a source module file, or a [KtCodeFragment].