DokkaSourceSetSpec
Source set level configuration.
Can be configured in the following way with Gradle Kotlin DSL:
// build.gradle.kts
dokkatoo {
dokkatooSourceSets {
// configure individual source set by name
named("customSourceSet") {
suppress.set(true)
}
// configure all source sets at once
configureEach {
reportUndocumented.set(true)
}
}
}Properties
Platform to be used for setting up code analysis and samples.
Kotlin API version used for setting up analysis and @sample environment.
Classpath for analysis and interactive samples.
Specifies source sets that current source set depends on.
Display name used to refer to the source set.
Set of visibility modifiers that should be documented.
Whether to generate external documentation links for Android SDK API reference when declarations from it are used.
Whether to generate external documentation links to JDK's Javadocs when declarations from it are used.
Whether to generate external documentation links that lead to API reference documentation for Kotlin's standard library when declarations from it are used.
Allows linking to Dokka/Javadoc documentation of the project's dependencies.
List of Markdown files that contain module and package documentation.
JDK version to use when generating external documentation links for Java types.
Kotlin language version used for setting up analysis and @sample environment.
Allows to customize documentation generation options on a per-package basis.
Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs after they have been filtered by documentedVisibilities.
List of directories or files that contain sample functions which are referenced via @sample KDoc tag.
Whether to document declarations annotated with Deprecated.
Whether to skip packages that contain no visible declarations after various filters have been applied.
Specifies the location of the project source code on the Web. If provided, Dokka generates "source" links for each declaration. See DokkaSourceLinkSpec for more details.
Source code roots to be analyzed and documented. Accepts directories and individual .kt / .java files.
The identifier for this source set, across all Gradle subprojects.
An arbitrary string used to group source sets that originate from different Gradle subprojects. This is primarily used by Kotlin Multiplatform projects, which can have multiple source sets per subproject.
Directories or individual files that should be suppressed, meaning declarations from them will be not documented.
Whether to document/analyze generated files.
Functions
Sets documentedVisibilities (overrides any previously set values).
Action for configuring package options, appending to perPackageOptions.
Configure and add a new source link to sourceLinks.