kotlin-analysis/org.jetbrains.dokka.analysis/AnalysisEnvironment

AnalysisEnvironment

class AnalysisEnvironment(val messageCollector: MessageCollector, val analysisPlatform: Platform) : Disposable

Kotlin as a service entry point

Configures environment, analyses files and provides facilities to perform code processing without emitting bytecode

$messageCollector: required by compiler infrastructure and will receive all compiler messages $body: optional and can be used to configure environment without creating local variable

Constructors

AnalysisEnvironment

constructor(messageCollector: MessageCollector, analysisPlatform: Platform)

Types

Companion

object Companion

Properties

analysisPlatform

val analysisPlatform: Platform

classpath

val classpath: List<File>

Classpath for this environment.

configuration

val configuration: CompilerConfiguration

messageCollector

val messageCollector: MessageCollector

sources

val sources: List<String>

List of source roots for this environment.

Functions

addClasspath

fun addClasspath(path: File)

Adds path to classpath. $path: path to add

fun addClasspath(paths: List<File>)

Adds list of paths to classpath. $paths: collection of files to add

addRoots

fun addRoots(list: List<ContentRoot>)

addSources

fun addSources(sourceDirectories: Iterable<File>)

Adds list of paths to source roots. $list: collection of files to add

configureJdkClasspathRoots

fun configureJdkClasspathRoots()

createCoreEnvironment

fun createCoreEnvironment(): KotlinCoreEnvironment

createResolutionFacade

fun createResolutionFacade(environment: KotlinCoreEnvironment, ignoreCommonBuiltIns: Boolean = false): Pair<DokkaResolutionFacade, DokkaResolutionFacade>

dispose

open override fun dispose()

Disposes the environment and frees all associated resources.

loadLanguageVersionSettings

fun loadLanguageVersionSettings(languageVersionString: String?, apiVersionString: String?)

registerLibraries

fun Collection<KotlinLibrary>.registerLibraries(): List<DokkaKlibLibraryInfo>