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

DokkaPackageOptionsSpec

abstract class DokkaPackageOptionsSpec @DokkatooInternalApi constructor : HasConfigurableVisibilityModifiers, Serializable(source)

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

Example in Gradle Kotlin DSL:

tasks.dokkaHtml {
    dokkaSourceSets.configureEach {
        perPackageOption {
            matchingRegex.set(".*internal.*")
            suppress.set(true)
        }
    }
}
Content copied to clipboard

Constructors

Link copied to clipboard
@DokkatooInternalApi
constructor()

Properties

Link copied to clipboard
@get:Input
abstract override val documentedVisibilities: SetProperty<VisibilityModifier>

Set of visibility modifiers that should be documented.

Link copied to clipboard
@get:Input
abstract val matchingRegex: Property<String>

Regular expression that is used to match the package.

Link copied to clipboard
@get:Input
abstract val reportUndocumented: Property<Boolean>

Whether to emit warnings about visible undocumented declarations, that is declarations from this package and without KDocs, after they have been filtered by documentedVisibilities.

Link copied to clipboard
@get:Input
abstract val skipDeprecated: Property<Boolean>

Whether to document declarations annotated with Deprecated.

Link copied to clipboard
@get:Input
abstract val suppress: Property<Boolean>

Whether this package should be skipped when generating documentation.

Functions

Link copied to clipboard
open fun documentedVisibilities(vararg visibilities: VisibilityModifier)

Sets documentedVisibilities (overrides any previously set values).