Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.dokka.parameters

Package-level declarations

Parameters for configuring the behaviour of Dokka Generator.

Types

abstract class DokkaExternalDocumentationLinkSpec @DokkatooInternalApi @Inject constructor(name: String) : Serializable, Named

Configuration builder that allows creating links leading to externally hosted documentation of your dependencies.

DokkaGeneratorParametersSpec

abstract class DokkaGeneratorParametersSpec @DokkatooInternalApi @Inject constructor(objects: ObjectFactory, val pluginsConfiguration: DokkaPluginParametersContainer) : ExtensionAware

Parameters used to run Dokka Generator to produce either a Dokka Publication or a Dokka Module.

DokkaModuleDescriptionKxs

@Serializable

@DokkatooInternalApi

data class DokkaModuleDescriptionKxs(val name: String, val modulePath: String, val moduleOutputDirName: String = "module", val moduleIncludesDirName: String = "includes")

Any subproject can be merged into a single Dokka Publication. To do this, first it must create a Dokka Module. A DokkaModuleDescriptionKxs describes a config file for the Dokka Module that describes its content. This config file will be used by any aggregating project to produce a Dokka Publication with multiple modules.

DokkaPackageOptionsSpec

abstract class DokkaPackageOptionsSpec @DokkatooInternalApi constructor : HasConfigurableVisibilityModifiers, Serializable

Configuration builder that allows setting some options for specific packages matched by matchingRegex.

DokkaSourceLinkSpec

abstract class DokkaSourceLinkSpec @DokkatooInternalApi @Inject constructor(layout: ProjectLayout) : Serializable

Configuration builder that allows adding a source link to each signature which leads to remoteUrl with a specific line number (configurable by setting remoteLineSuffix), letting documentation readers find source code for each declaration.

DokkaSourceSetIdSpec

abstract class DokkaSourceSetIdSpec @DokkatooInternalApi @Inject constructor(val scopeId: String, val sourceSetName: String) : Named, Serializable

DokkaSourceSetSpec

abstract class DokkaSourceSetSpec @DokkatooInternalApi @Inject constructor(name: String, objects: ObjectFactory) : HasConfigurableVisibilityModifiers, Named, Serializable, ExtensionAware

Source set level configuration.

KotlinPlatform

enum KotlinPlatform : Enum<KotlinPlatform>

The Kotlin Platform that code is compiled to.

VisibilityModifier

enum VisibilityModifier : Enum<VisibilityModifier>

Denotes the visibility modifier of a source code elements.