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

DokkaPublication

abstract class DokkaPublication @DokkatooInternalApi @Inject constructor(val formatName: String, pluginsConfiguration: DokkaPluginParametersContainer) : Named, Serializable, ExtensionAware(source)

A DokkaPublication describes a single Dokka output.

Each Publication has its own set of Gradle tasks and org.gradle.api.artifacts.Configurations.

The type of site is determined by the Dokka Plugins. By default, an HTML site will be generated. By default, Dokka will create publications for HTML, Jekyll, and GitHub Flavoured Markdown.

Constructors

Link copied to clipboard
@DokkatooInternalApi
@Inject
constructor(formatName: String, pluginsConfiguration: DokkaPluginParametersContainer)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val enabled: Property<Boolean>
Link copied to clipboard
abstract val failOnWarning: Property<Boolean>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val moduleName: Property<String>
Link copied to clipboard
abstract val moduleVersion: Property<String>
Link copied to clipboard
abstract val offlineMode: Property<Boolean>
Link copied to clipboard
abstract val outputDir: DirectoryProperty

Renamed - use outputDirectory instead.

Link copied to clipboard
abstract val outputDirectory: DirectoryProperty

Output directory for the finished Dokka publication.

Link copied to clipboard
val pluginsConfiguration: DokkaPluginParametersContainer

Configurations for Dokka Generator Plugins.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
open override fun getName(): String