From 52e012712ddd1e3eaab86e8c854204759f08dd76 Mon Sep 17 00:00:00 2001 From: Roman Golyshev Date: Tue, 31 Aug 2021 17:24:33 +0300 Subject: [PATCH] [FIR IDE] Add a little KDoc to `KtImportOptimizerMixIn::analyzeImports` --- .../idea/frontend/api/components/KtImportOptimizer.kt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/components/KtImportOptimizer.kt b/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/components/KtImportOptimizer.kt index 6d215640f15..e1bd1042964 100644 --- a/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/components/KtImportOptimizer.kt +++ b/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/components/KtImportOptimizer.kt @@ -14,6 +14,13 @@ public abstract class KtImportOptimizer : ValidityTokenOwner { } public interface KtImportOptimizerMixIn : KtAnalysisSessionMixIn { + + /** + * Takes [file] and inspects its imports and their usages, + * so they can be optimized based on the resulting [KtImportOptimizerResult]. + * + * Does **not** change the file. + */ public fun analyseImports(file: KtFile): KtImportOptimizerResult { return analysisSession.importOptimizer.analyseImports(file) }