The display name used to refer to the module. It is used for the table of contents, navigation, logging, etc.
Default: root
The module version.
Default: empty
The directory to where documentation is generated, regardless of output format.
Default: ./dokka
Whether to fail documentation generation if Dokka has emitted a warning or an error. The process waits until all errors and warnings have been emitted first.
This setting works well with reportUndocumented
Default: false
Whether to suppress obvious functions.
A function is considered to be obvious if it is:
kotlin.Any, Kotlin.Enum, java.lang.Object or
java.lang.Enum, such as equals, hashCode, toString.
dataClass.componentN or dataClass.copy.
Default: true
Whether to suppress inherited members that aren't explicitly overridden in a given class.
Note: This can suppress functions such as equals / hashCode / toString,
but cannot suppress synthetic functions such as dataClass.componentN and
dataClass.copy. Use suppressObviousFunctions
for that.
Default: false
Whether to resolve remote files/links over your network.
This includes package-lists used for generating external documentation links. For example, to make classes from the standard library clickable.
Setting this to true can significantly speed up build times in certain cases,
but can also worsen documentation quality and user experience. For example, by
not resolving class/member links from your dependencies, including the standard library.
Note: You can cache fetched files locally and provide them to
Dokka as local paths. See externalDocumentationLinks section.
Default: false
A list of Markdown files that contain module and package documentation.
The contents of specified files are parsed and embedded into documentation as module and package descriptions.
This can be configured on per-package basis.
Individual and additional configuration of Kotlin source sets.
For a list of possible options, see source set configuration.
The global configuration of source links that is applied for all source sets.
For a list of possible options, see source link configuration.
The global configuration of matched packages, regardless of the source set they are in.
For a list of possible options, see per-package configuration.
The global configuration of external documentation links, regardless of the source set they are used in.
For a list of possible options, see external documentation configuration.
A list of JAR files with Dokka plugins and their dependencies.
The display name used to refer to this source set.
The name is used both externally (for example, the source set name is visible to documentation readers) and
internally (for example, for logging messages of reportUndocumented).
The platform name can be used if you don't have a better alternative.
The technical ID of the source set
The set of visibility modifiers that should be documented.
This can be used if you want to document protected/internal/private declarations, as well as if you want to exclude public declarations and only document internal API.
This can be configured on per-package basis.
Possible values:
PUBLICPRIVATEPROTECTEDINTERNALPACKAGE
Default: PUBLIC
Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
after they have been filtered by documentedVisibilities and other filters.
This setting works well with failOnWarning.
This can be configured on per-package basis.
Default: false
Whether to skip packages that contain no visible declarations after various filters have been applied.
For example, if skipDeprecated is set to true and your package contains only
deprecated declarations, it is considered to be empty.
Default for CLI runner is false.
Whether to document declarations annotated with @Deprecated.
This can be configured on per-package basis.
Default: false
The JDK version to use when generating external documentation links for Java types.
For example, if you use java.util.UUID in some public declaration signature,
and this option is set to 8, Dokka generates an external documentation link
to JDK 8 Javadocs for it.
The Kotlin language version used for setting up analysis and @sample environment.
The Kotlin API version used for setting up analysis and @sample environment.
Whether to generate external documentation links that lead to the API reference documentation of Kotlin's standard library.
Note: Links are generated when noStdLibLink is set to false.
Default: false
Whether to generate external documentation links to JDK's Javadocs.
The version of JDK Javadocs is determined by the jdkVersion option.
Note: Links are generated when noJdkLink is set to false.
Default: false
A list of Markdown files that contain module and package documentation.
The contents of the specified files are parsed and embedded into documentation as module and package descriptions.
Platform to be used for setting up code analysis and @sample environment.
Possible values:
jvmcommonjsnative
The source code roots to be analyzed and documented.
Acceptable inputs are directories and individual .kt / .java files.
The classpath for analysis and interactive samples.
This is useful if some types that come from dependencies are not resolved/picked up automatically.
This option accepts both .jar and .klib files.
A list of directories or files that contain sample functions which are referenced via the @sample KDoc tag.
The files to be suppressed when generating documentation.
A set of parameters for source links that is applied only for this source set.
For a list of possible options, see source link configuration.
A set of parameters specific to matched packages within this source set.
For a list of possible options, see per-package configuration.
A set of parameters for external documentation links that is applied only for this source set.
For a list of possible options, see external documentation configuration.
The path to the local source directory.
The URL of the source code hosting service that can be accessed by documentation readers, like GitHub, GitLab, Bitbucket, etc. This URL is used to generate source code links of declarations.
The suffix used to append the source code line number to the URL. This helps readers navigate not only to the file, but to the specific line number of the declaration.
The number itself is appended to the specified suffix. For example,
if this option is set to #L and the line number is 10, the resulting URL suffix
is #L10.
Suffixes used by popular services:
#L#L#lines-
Default: empty (no suffix)
The regular expression that is used to match the package.
Whether this package should be skipped when generating documentation.
Default: false
Whether to document declarations annotated with @Deprecated.
This can be set on project/module level.
Default: false
Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
after they have been filtered by documentedVisibilities and other filters.
This setting works well with failOnWarning.
This can be configured on source set level.
Default: false
The set of visibility modifiers that should be documented.
This can be used if you want to document protected/internal/private declarations within this package, as well as if you want to exclude public declarations and only document internal API.
Can be configured on source set level.
Default: PUBLIC
The root URL of documentation to link to. It must contain a trailing slash.
Dokka does its best to automatically find package-list for the given URL,
and link declarations together.
If automatic resolution fails or if you want to use locally cached files instead,
consider setting the packageListUrl option.
The exact location of a package-list. This is an alternative to relying on Dokka
automatically resolving it.
Package lists contain information about the documentation and the project itself, such as module and package names.
This can also be a locally cached file to avoid network calls.