Package org.jetbrains.dokka

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 are applied to all packages and modules and overwrite package configuration.

PackageOptionsImpl

data class PackageOptionsImpl( val matchingRegex: String, val includeNonPublic: Boolean, val reportUndocumented: Boolean?, val skipDeprecated: Boolean, val suppress: Boolean, val documentedVisibilities: Set<DokkaConfiguration.Visibility>) : DokkaConfiguration.PackageOptions

Platform

enum Platform : Enum<Platform>

PluginConfigurationImpl