From 50203adb72e26817b7a4a8510e6a795825bef6c1 Mon Sep 17 00:00:00 2001 From: Yan Zhulanow Date: Fri, 19 Jan 2024 00:01:31 +0900 Subject: [PATCH] [Analysis API] Minor, add KDoc for 'ContextCollector.Context' --- .../low/level/api/fir/util/ContextCollector.kt | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/analysis/low-level-api-fir/src/org/jetbrains/kotlin/analysis/low/level/api/fir/util/ContextCollector.kt b/analysis/low-level-api-fir/src/org/jetbrains/kotlin/analysis/low/level/api/fir/util/ContextCollector.kt index 9aaa8d89705..7f60b482688 100644 --- a/analysis/low-level-api-fir/src/org/jetbrains/kotlin/analysis/low/level/api/fir/util/ContextCollector.kt +++ b/analysis/low-level-api-fir/src/org/jetbrains/kotlin/analysis/low/level/api/fir/util/ContextCollector.kt @@ -54,6 +54,16 @@ object ContextCollector { BODY } + /** + * Represents resolution context of a specific place in code (a context). + * + * @param towerDataContext a list of tower data elements that may define declaration scopes, implicit receivers, + * and additional information applicable either to the context element or its semantic parents. + * + * @param smartCasts a set of smart-casts (potentially) available to the context element. Note that the key, [RealVariable], includes + * stability. Only stable smart casts impact data flow. Check the "Smart cast sink stability" in the Kotlin language specification. + * Unstable smart casts are still provided for more precise checking and diagnosing. + */ class Context( val towerDataContext: FirTowerDataContext, val smartCasts: Map>,