Fix review

Kotlin · Jan 19, 2023 · b4314e0 · b4314e0
1 parent 833a9dc
commit b4314e0
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 13 deletions.
diff --git a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt
@@ -9,7 +9,7 @@ import org.jetbrains.dokka.plugability.DokkaContext
 import org.jetbrains.dokka.utilities.DokkaLogger
 import java.io.Closeable
 
-fun KotlinAnalysis(
+fun ProjectKotlinAnalysis(
     sourceSets: List<DokkaSourceSet>,
     logger: DokkaLogger,
     analysisConfiguration: DokkaAnalysisConfiguration = DokkaAnalysisConfiguration()
@@ -22,11 +22,13 @@ fun KotlinAnalysis(
             analysisConfiguration = analysisConfiguration
         )
     }
-    return ProjectKotlinAnalysis(environments)
+    return EnvironmentKotlinAnalysis(environments)
 }
 
 /**
  * [projectKotlinAnalysis] needs to be closed separately
+ *  Usually the analysis created for samples is short-lived and can be closed right after
+ *  it's been used, there's no need to wait for [projectKotlinAnalysis] to be closed as it must be handled separately.
  */
 fun SamplesKotlinAnalysis(
     sourceSets: List<DokkaSourceSet>,
@@ -46,7 +48,7 @@ fun SamplesKotlinAnalysis(
             )
     }
 
-    return SamplesKotlinAnalysis(environments, projectKotlinAnalysis)
+    return EnvironmentKotlinAnalysis(environments, projectKotlinAnalysis)
 }
 
 class DokkaAnalysisConfiguration(
@@ -60,7 +62,18 @@ class DokkaAnalysisConfiguration(
 @Deprecated(message = "Construct using list of DokkaSourceSets and logger",
     replaceWith = ReplaceWith("KotlinAnalysis(context.configuration.sourceSets, context.logger)")
 )
-fun KotlinAnalysis(context: DokkaContext): KotlinAnalysis = KotlinAnalysis(context.configuration.sourceSets, context.logger)
+fun KotlinAnalysis(context: DokkaContext): KotlinAnalysis =
+    ProjectKotlinAnalysis(context.configuration.sourceSets, context.logger)
+
+@Deprecated(message = "It was renamed to `ProjectKotlinAnalysis`",
+    replaceWith = ReplaceWith("ProjectKotlinAnalysis(sourceSets, logger, analysisConfiguration)")
+)
+fun KotlinAnalysis(
+    sourceSets: List<DokkaSourceSet>,
+    logger: DokkaLogger,
+    analysisConfiguration: DokkaAnalysisConfiguration = DokkaAnalysisConfiguration()
+) = ProjectKotlinAnalysis(sourceSets, logger, analysisConfiguration)
+
 
 /**
  * First child delegation. It does not close [parent].
@@ -103,12 +116,4 @@ internal open class EnvironmentKotlinAnalysis(
     }
 }
 
-internal class ProjectKotlinAnalysis(
-    environments: SourceSetDependent<AnalysisContext>
-) : EnvironmentKotlinAnalysis(environments)
-
-internal class SamplesKotlinAnalysis(
-    sampleEnvironments: SourceSetDependent<AnalysisContext>,
-    projectKotlinAnalysis: KotlinAnalysis
-) : EnvironmentKotlinAnalysis(sampleEnvironments, projectKotlinAnalysis)
 
diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -4,6 +4,7 @@ package org.jetbrains.dokka.base
 
 import org.jetbrains.dokka.CoreExtensions
 import org.jetbrains.dokka.analysis.KotlinAnalysis
+import org.jetbrains.dokka.analysis.ProjectKotlinAnalysis
 import org.jetbrains.dokka.base.renderers.*
 import org.jetbrains.dokka.base.renderers.html.*
 import org.jetbrains.dokka.base.renderers.html.command.consumers.PathToRootConsumer
@@ -191,7 +192,7 @@ class DokkaBase : DokkaPlugin() {
 
     val defaultKotlinAnalysis by extending {
         kotlinAnalysis providing { ctx ->
-            KotlinAnalysis(
+            ProjectKotlinAnalysis(
                 sourceSets = ctx.configuration.sourceSets,
                 logger = ctx.logger
             )