Dokkatoo Gradle Plugin/dev.adamko.dokkatoo/DokkatooExtension

DokkatooExtension

abstract class DokkatooExtension @DokkatooInternalApi constructor(objects: ObjectFactory, baseDependencyManager: BaseDependencyManager) : ExtensionAware, Serializable(source)

Configure the behaviour of the DokkatooBasePlugin.

Constructors

Link copied to clipboard
@DokkatooInternalApi
constructor(objects: ObjectFactory, baseDependencyManager: BaseDependencyManager)

Types

Link copied to clipboard
interface Versions : ExtensionAware

Properties

Link copied to clipboard
abstract val dokkaGeneratorIsolation: Property<WorkerIsolation>

Dokkatoo runs Dokka Generator in a separate Gradle Worker.

Link copied to clipboard
abstract val dokkatooCacheDirectory: DirectoryProperty

Default Dokkatoo cache directory

Link copied to clipboard
Link copied to clipboard
abstract val dokkatooModuleDirectory: DirectoryProperty

Directory into which Dokka Modules will be produced.

Link copied to clipboard
abstract val dokkatooPublicationDirectory: DirectoryProperty

Directory into which DokkaPublications will be produced

Link copied to clipboard
val dokkatooPublications: NamedDomainObjectContainer<DokkaPublication>

Configuration for creating Dokka Publications.

Link copied to clipboard
val dokkatooSourceSets: NamedDomainObjectContainer<DokkaSourceSetSpec>

Dokka Source Sets describe the source code that should be included in a Dokka Publication.

Link copied to clipboard
@DokkatooInternalApi
abstract val konanHome: RegularFileProperty

The Konan home directory, which contains libraries for Kotlin/Native development.

Link copied to clipboard
abstract val moduleName: Property<String>
Link copied to clipboard
abstract val modulePath: Property<String>
Link copied to clipboard
abstract val moduleVersion: Property<String>
Link copied to clipboard
val pluginsConfiguration: DokkaPluginParametersContainer

Dokka Plugin are used to configure the way Dokka generates a format. Some plugins can be configured via parameters, and those parameters are stored in this container.

Link copied to clipboard
abstract val sourceSetScopeDefault: Property<String>

An arbitrary string used to group source sets that originate from different Gradle subprojects.

Link copied to clipboard
val versions: DokkatooExtension.Versions

Versions of dependencies that Dokkatoo will use to run Dokka Generator.

Functions

Link copied to clipboard
fun ClassLoaderIsolation(configure: ClassLoaderIsolation.() -> Unit = {}): ClassLoaderIsolation

Create a new ClassLoaderIsolation options instance.

Link copied to clipboard
Link copied to clipboard
fun ProcessIsolation(configure: ProcessIsolation.() -> Unit = {}): ProcessIsolation

Create a new ProcessIsolation options.