Package org.jetbrains.dokka

Types

CoreExtensions

object CoreExtensions

DokkaBootstrap

interface DokkaBootstrap

DokkaBootstrapImpl

class DokkaBootstrapImpl : DokkaBootstrap

Accessed with reflection

DokkaConfiguration

interface DokkaConfiguration : Serializable

DokkaConfigurationBuilder

fun fun interface DokkaConfigurationBuilder<T : Any>

DokkaConfigurationImpl

data class DokkaConfigurationImpl(moduleName: String, moduleVersion: String?, outputDir: File, cacheRoot: File?, offlineMode: Boolean, sourceSets: List<DokkaSourceSetImpl>, pluginsClasspath: List<File>, pluginsConfiguration: List<PluginConfigurationImpl>, modules: List<DokkaModuleDescriptionImpl>, failOnWarning: Boolean, delayTemplateSubstitution: Boolean, suppressObviousFunctions: Boolean, includes: Set<File>, suppressInheritedMembers: Boolean, finalizeCoroutines: Boolean) : 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 documentationgenerate method has been split into submethods for test reasons

DokkaModuleDescriptionImpl

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

DokkaSourceSetID

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

DokkaSourceSetImpl

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

DokkaVersion

object DokkaVersion

ExternalDocumentationLinkImpl

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

GlobalDokkaConfiguration

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

Global options are applied to all packages and modules and overwrite package configuration.

PackageOptionsImpl

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

Platform

enum Platform : Enum<Platform>

PluginConfigurationImpl

data class PluginConfigurationImpl(fqPluginName: String, serializationFormat: DokkaConfiguration.SerializationFormat, values: String) : DokkaConfiguration.PluginConfiguration

SourceLinkDefinitionImpl

data class SourceLinkDefinitionImpl(localDirectory: String, remoteUrl: URL, remoteLineSuffix: String?) : DokkaConfiguration.SourceLinkDefinition

Timer

class Timer

Functions

androidSdk

fun DokkaConfiguration.ExternalDocumentationLink.Companion.androidSdk(): ExternalDocumentationLinkImpl

androidX

fun DokkaConfiguration.ExternalDocumentationLink.Companion.androidX(): ExternalDocumentationLinkImpl

apply

fun DokkaConfiguration.apply(globals: GlobalDokkaConfiguration): DokkaConfiguration

build

fun <T : Any> Iterable<DokkaConfigurationBuilder<T>>.build(): List<T>

DokkaConfigurationImpl

fun DokkaConfigurationImpl(json: String): DokkaConfigurationImpl

ExternalDocumentationLink

fun ExternalDocumentationLink(url: URL? = null, packageListUrl: URL? = null): ExternalDocumentationLinkImpl

fun ExternalDocumentationLink(url: String, packageListUrl: String? = null): ExternalDocumentationLinkImpl

GlobalDokkaConfiguration

fun GlobalDokkaConfiguration(json: String): GlobalDokkaConfiguration

jdk

fun DokkaConfiguration.ExternalDocumentationLink.Companion.jdk(jdkVersion: Int): ExternalDocumentationLinkImpl

kotlinStdlib

fun DokkaConfiguration.ExternalDocumentationLink.Companion.kotlinStdlib(): ExternalDocumentationLinkImpl

parsePerPackageOptions

fun parsePerPackageOptions(args: List<String>): List<DokkaConfiguration.PackageOptions>

toJsonString

fun <T : ConfigurableBlock> T.toJsonString(): String

fun DokkaConfiguration.toJsonString(): String