aboutsummaryrefslogtreecommitdiff
path: root/kotlin-analysis
diff options
context:
space:
mode:
authoraSemy <897017+aSemy@users.noreply.github.com>2023-04-25 22:27:35 +0200
committerGitHub <noreply@github.com>2023-04-25 22:27:35 +0200
commitfcb2f4ae72bdc62df37e61360d2d206c36717612 (patch)
treefbcbfeae30e3d0ada54299b9f3d7db62a036ad75 /kotlin-analysis
parent609c5469bbc0ba3516e760c6e61cf7df2b5c7ff7 (diff)
downloaddokka-fcb2f4ae72bdc62df37e61360d2d206c36717612.tar.gz
dokka-fcb2f4ae72bdc62df37e61360d2d206c36717612.tar.bz2
dokka-fcb2f4ae72bdc62df37e61360d2d206c36717612.zip
Tidy/remove unnecessary imports and suppressions (#2975)
Diffstat (limited to 'kotlin-analysis')
-rw-r--r--kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt18
1 files changed, 10 insertions, 8 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
index 64a583b6..27328a6c 100644
--- a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt
+++ b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
package org.jetbrains.dokka.analysis
import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
@@ -9,6 +7,7 @@ import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.utilities.DokkaLogger
import java.io.Closeable
+@Suppress("FunctionName")
fun ProjectKotlinAnalysis(
sourceSets: List<DokkaSourceSet>,
logger: DokkaLogger,
@@ -30,6 +29,7 @@ fun ProjectKotlinAnalysis(
* 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.
*/
+@Suppress("FunctionName")
fun SamplesKotlinAnalysis(
sourceSets: List<DokkaSourceSet>,
logger: DokkaLogger,
@@ -46,7 +46,7 @@ fun SamplesKotlinAnalysis(
sourceSet = sourceSet,
analysisConfiguration = analysisConfiguration
)
- }
+ }
return EnvironmentKotlinAnalysis(environments, projectKotlinAnalysis)
}
@@ -59,13 +59,15 @@ class DokkaAnalysisConfiguration(
val ignoreCommonBuiltIns: Boolean = false
)
-@Deprecated(message = "Construct using list of DokkaSourceSets and logger",
+@Deprecated(
+ message = "Construct using list of DokkaSourceSets and logger",
replaceWith = ReplaceWith("KotlinAnalysis(context.configuration.sourceSets, context.logger)")
)
fun KotlinAnalysis(context: DokkaContext): KotlinAnalysis =
ProjectKotlinAnalysis(context.configuration.sourceSets, context.logger)
-@Deprecated(message = "It was renamed to `ProjectKotlinAnalysis`",
+@Deprecated(
+ message = "It was renamed to `ProjectKotlinAnalysis`",
replaceWith = ReplaceWith("ProjectKotlinAnalysis(sourceSets, logger, analysisConfiguration)")
)
fun KotlinAnalysis(
@@ -85,11 +87,13 @@ abstract class KotlinAnalysis(
operator fun get(key: DokkaSourceSet): AnalysisContext {
return get(key.sourceSetID)
}
+
operator fun get(key: DokkaSourceSetID): AnalysisContext {
return find(key)
?: parent?.get(key)
- ?: throw IllegalStateException("Missing EnvironmentAndFacade for sourceSet ${key}")
+ ?: throw IllegalStateException("Missing EnvironmentAndFacade for sourceSet $key")
}
+
protected abstract fun find(sourceSetID: DokkaSourceSetID): AnalysisContext?
}
@@ -105,5 +109,3 @@ internal open class EnvironmentKotlinAnalysis(
environments.values.forEach(AnalysisContext::close)
}
}
-
-