gradle-plugin/org.jetbrains.dokka.gradle/GradlePackageOptionsBuilder

GradlePackageOptionsBuilder

class GradlePackageOptionsBuilder(project: Project) : DokkaConfigurationBuilder<PackageOptionsImpl>

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
fun GradlePackageOptionsBuilder(project: Project)

Functions

Link copied to clipboard
open override fun build(): PackageOptionsImpl

Properties

Link copied to clipboard
@Input
val documentedVisibilities: SetProperty<DokkaConfiguration.Visibility>

Set of visibility modifiers that should be documented.

Link copied to clipboard
@Input
val includeNonPublic: Property<Boolean>

Deprecated. Use documentedVisibilities instead.

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

Regular expression that is used to match the package.

Link copied to clipboard
@Input
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
@Input
val skipDeprecated: Property<Boolean>

Whether to document declarations annotated with Deprecated.

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

Whether this package should be skipped when generating documentation.