core/org.jetbrains.dokka

Package-level declarations

Types

CoreExtensions

object CoreExtensions

DokkaBootstrap

interface DokkaBootstrap

DokkaBootstrapImpl

class DokkaBootstrapImpl : DokkaBootstrap

Accessed with reflection

DokkaConfiguration

interface DokkaConfiguration : Serializable

DokkaConfigurationBuilder

fun interface DokkaConfigurationBuilder<T : Any>

DokkaConfigurationImpl

data class DokkaConfigurationImpl(val moduleName: String = DokkaDefaults.moduleName, val moduleVersion: String? = DokkaDefaults.moduleVersion, val outputDir: File = DokkaDefaults.outputDir, val cacheRoot: File? = DokkaDefaults.cacheRoot, val offlineMode: Boolean = DokkaDefaults.offlineMode, val sourceSets: List<DokkaSourceSetImpl> = emptyList(), val pluginsClasspath: List<File> = emptyList(), val pluginsConfiguration: List<PluginConfigurationImpl> = DokkaDefaults.pluginsConfiguration, val modules: List<DokkaModuleDescriptionImpl> = emptyList(), val failOnWarning: Boolean = DokkaDefaults.failOnWarning, val delayTemplateSubstitution: Boolean = false, val suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions, val includes: Set<File> = emptySet(), val suppressInheritedMembers: Boolean = DokkaDefaults.suppressInheritedMembers, val finalizeCoroutines: Boolean = true) : DokkaConfiguration

DokkaDefaults

object DokkaDefaults

DokkaException

open class DokkaException(message: String) : RuntimeException

DokkaGenerator

class DokkaGenerator(configuration: DokkaConfiguration, logger: DokkaLogger)

DokkaGenerator is the main entry point for generating documentation

DokkaModuleDescriptionImpl

data class DokkaModuleDescriptionImpl(val name: String, val relativePathToOutputDirectory: File, val includes: Set<File>, val sourceOutputDirectory: File) : DokkaConfiguration.DokkaModuleDescription

DokkaSourceSetID

data class DokkaSourceSetID(val scopeId: String, val sourceSetName: String) : Serializable

DokkaSourceSetImpl

data class DokkaSourceSetImpl(val displayName: String = DokkaDefaults.sourceSetDisplayName, val sourceSetID: DokkaSourceSetID, val classpath: List<File> = emptyList(), val sourceRoots: Set<File> = emptySet(), val dependentSourceSets: Set<DokkaSourceSetID> = emptySet(), val samples: Set<File> = emptySet(), val includes: Set<File> = emptySet(), val includeNonPublic: Boolean = DokkaDefaults.includeNonPublic, val reportUndocumented: Boolean = DokkaDefaults.reportUndocumented, val skipEmptyPackages: Boolean = DokkaDefaults.skipEmptyPackages, val skipDeprecated: Boolean = DokkaDefaults.skipDeprecated, val jdkVersion: Int = DokkaDefaults.jdkVersion, val sourceLinks: Set<SourceLinkDefinitionImpl> = mutableSetOf(), val perPackageOptions: List<PackageOptionsImpl> = mutableListOf(), val externalDocumentationLinks: Set<ExternalDocumentationLinkImpl> = mutableSetOf(), val languageVersion: String? = null, val apiVersion: String? = null, val noStdlibLink: Boolean = DokkaDefaults.noStdlibLink, val noJdkLink: Boolean = DokkaDefaults.noJdkLink, val suppressedFiles: Set<File> = emptySet(), val analysisPlatform: Platform = DokkaDefaults.analysisPlatform, val documentedVisibilities: Set<DokkaConfiguration.Visibility> = DokkaDefaults.documentedVisibilities) : DokkaConfiguration.DokkaSourceSet

DokkaVersion

object DokkaVersion

ExternalDocumentationLinkImpl

data class ExternalDocumentationLinkImpl(val url: URL, val packageListUrl: URL) : DokkaConfiguration.ExternalDocumentationLink

GlobalDokkaConfiguration

data class GlobalDokkaConfiguration(val perPackageOptions: List<PackageOptionsImpl>?, val externalDocumentationLinks: List<ExternalDocumentationLinkImpl>?, val sourceLinks: List<SourceLinkDefinitionImpl>?)

Global options can be configured and applied to all packages and modules at once, overwriting package configuration.

InternalDokkaApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.FIELD, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class InternalDokkaApi

Marks declarations that are internal to Dokka core artifact. It means that this API is marked as public either for historical or technical reasons. It is not intended to be used outside of the Dokka project, has no behaviour guarantees, and may lack clear semantics, documentation and backward compatibility.

PackageOptionsImpl