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

DokkaGeneratorParametersSpec

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

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

Constructors

Link copied to clipboard
@DokkatooInternalApi
@Inject
constructor(objects: ObjectFactory, pluginsConfiguration: DokkaPluginParametersContainer)

Properties

Link copied to clipboard
@get:Internal
abstract val dokkaModuleFiles: ConfigurableFileCollection

Dokka Module files from other subprojects.

Link copied to clipboard
val dokkaSourceSets: NamedDomainObjectContainer<DokkaSourceSetSpec>

Source sets used to generate a Dokka Module.

Link copied to clipboard
@get:Input
abstract val failOnWarning: Property<Boolean>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:Input
abstract val moduleName: Property<String>
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val moduleOutputDirectories: ConfigurableFileCollection

Dokka Modules directories, containing the output, module descriptor, and module includes.

Link copied to clipboard
@get:Input
@get:Optional
abstract val moduleVersion: Property<String>
Link copied to clipboard
@get:Input
abstract val offlineMode: Property<Boolean>
Link copied to clipboard
@get:InputFiles
@get:Classpath
abstract val pluginsClasspath: ConfigurableFileCollection

Classpath that contains the Dokka Generator Plugins used to modify this publication.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard