kotlin-analysis/org.jetbrains.dokka.analysis

Package-level declarations

Types

class AnalysisContext(environment: KotlinCoreEnvironment, facade: DokkaResolutionFacade, analysisEnvironment: AnalysisEnvironment) : Closeable

AnalysisEnvironment

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

Kotlin as a service entry point

CoreKotlinCacheService

class CoreKotlinCacheService(resolutionFacade: DokkaResolutionFacade) : KotlinCacheService

DescriptorDocumentableSource

class DescriptorDocumentableSource(val descriptor: DeclarationDescriptor) : DocumentableSource

DokkaAnalysisConfiguration

class DokkaAnalysisConfiguration(val ignoreCommonBuiltIns: Boolean = false)

DokkaMessageCollector

class DokkaMessageCollector(logger: DokkaLogger) : MessageCollector

DokkaResolutionFacade

class DokkaResolutionFacade(val project: Project, val moduleDescriptor: ModuleDescriptor, val resolverForModule: ResolverForModule) : ResolutionFacade

KotlinAnalysis

abstract class KotlinAnalysis(val parent: KotlinAnalysis? = null) : Closeable

First child delegation. It does not close parent.

PsiDocumentableSource

class PsiDocumentableSource(val psi: PsiNamedElement) : DocumentableSource

Properties

JAR_SEPARATOR

const val JAR_SEPARATOR: String

Functions

from

fun Callable.Companion.from(psi: PsiField): Callable

fun Callable.Companion.from(psi: PsiMethod): Callable

fun DRI.Companion.from(psi: PsiElement): DRI

fun DRI.Companion.from(descriptor: DeclarationDescriptor): DRI

fun DriTarget.Companion.from(psi: PsiElement): DriTarget

fun DriTarget.Companion.from(descriptor: DeclarationDescriptor): DriTarget

fun TypeReference.Companion.from(p: PsiClass): TypeReference.Companion

fun TypeReference.Companion.from(d: ReceiverParameterDescriptor): TypeReference?

fun TypeReference.Companion.from(d: ValueParameterDescriptor): TypeReference

fun Callable.Companion.from(descriptor: CallableDescriptor, name: String? = null): Callable

KotlinAnalysis

fun ~~KotlinAnalysis~~(context: DokkaContext): KotlinAnalysis

fun ~~KotlinAnalysis~~(sourceSets: List<DokkaConfiguration.DokkaSourceSet>, logger: DokkaLogger, analysisConfiguration: DokkaAnalysisConfiguration = DokkaAnalysisConfiguration()): KotlinAnalysis

ProjectKotlinAnalysis

fun ProjectKotlinAnalysis(sourceSets: List<DokkaConfiguration.DokkaSourceSet>, logger: DokkaLogger, analysisConfiguration: DokkaAnalysisConfiguration = DokkaAnalysisConfiguration()): KotlinAnalysis

SamplesKotlinAnalysis

fun SamplesKotlinAnalysis(sourceSets: List<DokkaConfiguration.DokkaSourceSet>, logger: DokkaLogger, projectKotlinAnalysis: KotlinAnalysis, analysisConfiguration: DokkaAnalysisConfiguration = DokkaAnalysisConfiguration()): KotlinAnalysis

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.