Whether this source set should be skipped when generating documentation.
- Default is false.
+ Default: false.
- Display name used to refer to the source set.
+ The display name used to refer to the source set.
- The name will be used both externally (for example, as source set name visible to documentation readers) and
+ The name is used both externally (for example, as source set name visible to documentation readers) and
internally (for example, for logging messages of reportUndocumented).
By default, the value is deduced from information provided by the Kotlin Gradle plugin.
- Set of visibility modifiers that should be documented.
+ 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.
Can be configured on per-package basis.
- Default is DokkaConfiguration.Visibility.PUBLIC.
+ Default: DokkaConfiguration.Visibility.PUBLIC.
Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
after they have been filtered by documentedVisibilities.
- This setting works well with failOnWarning. Can be overridden for a specific package.
- Default is false.
+ This setting works well with failOnWarning. It can be overridden for a specific package.
+ Default: false.
@@ -663,106 +665,109 @@ tasks.withType(DokkaTask.class) {
various filters have been applied.
- For instance, if skipDeprecated is set to true and your package contains only
- deprecated declarations, it will be considered to be empty.
+ For example, if skipDeprecated is set to true and your package contains only
+ deprecated declarations, it is considered to be empty.
- Default is true.
+ Default: true.
Whether to document declarations annotated with @Deprecated.
- Can be overridden on package level.
- Default is false.
+ It can be overridden at package level.
+ Default: false.
Whether to document/analyze generated files.
- Generated files are expected to be present under {project}/{buildDir}/generated directory.
- If set to true, it effectively adds all files from that directory to
+ Generated files are expected to be present under the {project}/{buildDir}/generated directory.
+ If set to true, it effectively adds all files from that directory to the
suppressedFiles option, so you can configure it manually.
- Default is true.
+ Default: true.
- JDK version to use when generating external documentation links for Java types.
+ The JDK version to use when generating external documentation links for Java types.
- For instance, if you use java.util.UUID from JDK in some public declaration signature,
- and this property is set to 8, Dokka will generate an external documentation link
+ For example, if you use java.util.UUID from the JDK in some public declaration signature,
+ and this property is set to 8, Dokka generates an external documentation link
to JDK 8 Javadocs for it.
- Default is JDK 8.
+ Default: JDK 8.
- Kotlin language version
+ The Kotlin language version
used for setting up analysis and @sample
environment.
- By default, the latest language version available to Dokka's embedded compiler will be used.
+ By default, the latest language version available to Dokka's embedded compiler is used.
- Kotlin API version
+ The Kotlin API version
used for setting up analysis and @sample
environment.
- By default, it will be deduced from languageVersion.
+ By default, it is deduced from languageVersion.
Whether to generate external documentation links that lead to API reference
documentation for Kotlin's standard library when declarations from it are used.
- Default is false, meaning links will be generated.
+ Links are generated when `noStdLibLink` is set to false.
+ Default: false.
Whether to generate external documentation links to JDK's Javadocs when declarations from it are used.
- The version of JDK Javadocs is determined by jdkVersion property.
- Default is false, meaning links will be generated.
+ The version of JDK Javadocs is determined by the jdkVersion property.
+ Links are generated when `noJdkLink` is set to false.
+ Default: false.
Whether to generate external documentation links for Android SDK API reference
when declarations from it are used.
- Only relevant in Android projects, ignored otherwise.
- Default is false, meaning links will be generated.
+ This is only relevant in Android projects, ignored otherwise.
+ Links are generated when `noAndroidSdkLink` is set to false.
+ Default: false.
- List of Markdown files that contain
+ A list of Markdown files that contain
module and package documentation.
- Contents of specified files will be parsed and embedded into documentation as module and package descriptions.
+ The contents of the specified files are parsed and embedded into documentation as module and package descriptions.
See Dokka gradle example
- for an example of how to use it and what it will look like.
+ for an example of how to use it and what it looks like.
- Platform to be used for setting up code analysis and
+ The platform to be used for setting up code analysis and
@sample environment.
The default value is deduced from information provided by the Kotlin Gradle plugin.
- Source code roots to be analyzed and documented.
- Accepts directories and individual .kt / .java files.
+ The source code roots to be analyzed and documented.
+ Acceptable formats are directories and individual .kt / .java files.
By default, source roots are deduced from information provided by the Kotlin Gradle plugin.
- Classpath for analysis and interactive samples.
+ The classpath for analysis and interactive samples.
- Useful if some types that come from dependencies are not resolved/picked up automatically.
- Property accepts both .jar and .klib files.
+ This iu Useful if some types that come from dependencies are not resolved/picked up automatically.
+ The property accepts both .jar and .klib files.
By default, classpath is deduced from information provided by the Kotlin Gradle plugin.
- List of directories or files that contain sample functions which are referenced via
+ A list of directories or files that contain sample functions which are referenced via
@sample KDoc tag.
@@ -770,13 +775,13 @@ tasks.withType(DokkaTask.class) {
### Source link configuration
-Configuration block that allows adding a `source` link to each signature
-which leads to `remoteUrl` with a specific line number (configurable by setting `remoteLineSuffix`),
-letting documentation readers find source code for each declaration.
+The `sourceLinks` configuration block is where you can add a `source` link to each signature
+that leads to a `remoteUrl` with a specific line number. (The line number is configurable by setting `remoteLineSuffix`).
+This helps readers to find the source code for each declaration.
-For an example, see documentation for
-[count](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/count.html)
-function from `kotlinx.coroutines`.
+For an example, see the documentation for the
+[`count()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/count.html)
+function in `kotlinx.coroutines`.
@@ -836,26 +841,26 @@ tasks.withType(DokkaTask.class) {
- Path to the local source directory. The path must be relative to the root of
- current project.
+ The path to the local source directory. The path must be relative to the root of
+ the current project.
- URL of source code hosting service that can be accessed by documentation readers,
- like GitHub, GitLab, Bitbucket, etc. This URL will be used to generate
+ 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.
- Suffix used to append source code line number to the URL. This will help readers navigate
+ 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 will be appended to the specified suffix. For instance,
- if this property is set to #L and the line number is 10, resulting URL suffix
- will be #L10.
+ The number itself is appended to the specified suffix. For example,
+ if this property is set to #L and the line number is 10, the resulting URL suffix
+ is #L10.
Suffixes used by popular services:
@@ -865,13 +870,13 @@ tasks.withType(DokkaTask.class) {
Bitbucket: #lines-
- Default is #L.
+ Default: #L.
### Package options
-Configuration block that allows setting some options for specific packages matched by `matchingRegex`.
+Here is an example of a configuration block that allows setting some options for specific packages matched by `matchingRegex`.
@@ -910,12 +915,12 @@ import org.jetbrains.dokka.gradle.DokkaTask
tasks.withType(DokkaTask.class) {
// ..
- // general configuration section
+ // General configuration section
// ..
dokkaSourceSets.configureEach {
// ..
- // source set configuration section
+ // Source set configuration section
// ..
perPackageOption {
@@ -934,47 +939,47 @@ tasks.withType(DokkaTask.class) {
- Regular expression that is used to match the package.
- Default is any string: .*.
+ The regular expression that is used to match the package.
+ Default: any string: .*.
Whether this package should be skipped when generating documentation.
- Default is false.
+ Default: false.
Whether to document declarations annotated with @Deprecated.
- Can be configured on source set level.
- Default is false.
+ This can be configured on source set level.
+ Default: false.
- Whether to emit warnings about visible undocumented declarations, that is declarations from
+ Whether to emit warnings about visible undocumented declarations. That is declarations from
this package and without KDocs, after they have been filtered by documentedVisibilities.
This setting works well with failOnWarning.
- Can be configured on source set level.
- Default is false.
+ This can be configured on source set level.
+ Default: false.
- Set of visibility modifiers that should be documented.
+ The set of visibility modifiers that should be documented.
This can be used if you want to document protected/internal/private declarations within a
specific package, as well as if you want to exclude public declarations and only document internal API.
- Can be configured on source set level.
- Default is DokkaConfiguration.Visibility.PUBLIC.
+ This can be configured on source set level.
+ Default: DokkaConfiguration.Visibility.PUBLIC.
### External documentation links configuration
-Configuration block that allows creating links leading to externally hosted documentation of your dependencies.
+The externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of your dependencies.
-For instance, if you are using types from `kotlinx.serialization`, by default they will be unclickable in your
-documentation, as if unresolved. However, since API reference for `kotlinx.serialization` is also built by Dokka and is
-[published on kotlinlang.org](https://kotlinlang.org/api/kotlinx.serialization/), you can configure external
-documentation links for it, allowing Dokka to generate links for used types, making them clickable
-and appear resolved.
+For example, if you are using types from `kotlinx.serialization`, by default they are unclickable in your
+documentation, as if they are unresolved. However, since the API reference for `kotlinx.serialization` is also built by Dokka and is
+[published on kotlinlang.org](https://kotlinlang.org/api/kotlinx.serialization/), you can configure external
+documentation links for it. Thus allowing Dokka to generate links for types, making them clickable
+and resolve successfully.
@@ -1035,9 +1040,9 @@ tasks.withType(DokkaTask.class) {
- Root URL of documentation to link with. Must contain a trailing slash.
+ The root URL of documentation to link with. It **must** contain a trailing slash.
- Dokka will do its best to automatically find package-list for the given URL,
+ Dokka does its best to automatically find package-list for the given URL,
and link declarations together.
@@ -1048,14 +1053,14 @@ tasks.withType(DokkaTask.class) {
Specifies the exact location of a package-list instead of relying on Dokka
- automatically resolving it. Can also be a locally cached file to avoid network calls.
+ automatically resolving it. It can also be a locally cached file to avoid network calls.
### Complete configuration
-Below you can see all possible configuration options applied at once.
+Below you can see all possible configuration options applied at the same time.
diff --git a/docs/topics/runners/maven.md b/docs/topics/runners/maven.md
index a571090c194..7ba7dcea44f 100644
--- a/docs/topics/runners/maven.md
+++ b/docs/topics/runners/maven.md
@@ -1,18 +1,18 @@
[//]: # (title: Maven plugin)
-To generate documentation for Maven-based projects, you can use [Dokka Maven plugin](#applying-the-plugin).
+To generate documentation for Maven-based projects, you can use the [Dokka Maven plugin](#applying-the-plugin).
-> Compared to the [Gradle plugin](gradle.md), Maven plugin has only basic features and
+> Compared to the [Gradle plugin](gradle.md), the Maven plugin has only basic features and
> does not provide support for multimodule builds out of the box.
>
{type="note"}
You can play around with Dokka and see how it can be configured for a Maven project by visiting
-[Maven example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/maven) project.
+our [Maven example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/maven) project.
## Applying the plugin
-To apply the plugin, you need to add it to the plugins section of your POM:
+To apply the plugin, you need to add it to the plugins section of your POM file:
```xml
@@ -36,7 +36,7 @@ To apply the plugin, you need to add it to the plugins section of your POM:
## Generating documentation
-Following goals are provided by the plugin:
+The following goals are provided by the plugin:
### Stable
@@ -53,13 +53,11 @@ Following goals are provided by the plugin:
### Other output formats
-By default, Maven plugin will build documentation in [HTML](html.md) format.
+By default, the Maven plugin builds documentation in [HTML](html.md) output format.
-All other output formats come as [Dokka plugins](plugins_introduction.md). In order to use it, you have to apply
-it as a dependency.
+All other output formats come as part of [Dokka plugins](plugins_introduction.md). In order to use them, you have to apply
-For example, to use experimental [GFM](markdown.md#gfm) format, you have to apply `org.jetbrains.dokka:gfm-plugin` in
-the following way:
+For example, to use the experimental [GFM](markdown.md#gfm) format, you have to apply `org.jetbrains.dokka:gfm-plugin` in
```xml
@@ -78,18 +76,18 @@ the following way:
```
-After that, running `dokka:dokka` goal should produce documentation in GFM format.
+With this configuration, running the `dokka:dokka` goal produces documentation in GFM format.
-You can learn more about Dokka plugins in [a separate topic](plugins_introduction.md).
+To learn more about Dokka plugins, see [Dokka plugins](plugins_introduction.md).
## Building javadoc.jar
-Unlike the [Gradle plugin](gradle.md#building-javadoc-jar), Maven plugin comes with ready-to-use `dokka:javadocJar` goal.
-By default, it will generate documentation in [Javadoc](javadoc.md) format under `target` folder.
+Unlike the [Gradle plugin](gradle.md#building-javadoc-jar), the Maven plugin comes with a ready-to-use `dokka:javadocJar` goal.
+By default, it generates documentation in [Javadoc](javadoc.md) output format in the`target` folder.
If you are not satisfied with the built-in goal or want to customize the output (for instance, you want to generate
-documentation in [HTML](html.md) format instead of Javadoc), similar behaviour can be achieved by adding the
-Maven jar plugin with the following configuration:
+documentation in [HTML](html.md) format instead of Javadoc), similar behavior can be achieved by adding the
+Maven JAR plugin with the following configuration:
```xml
@@ -118,7 +116,7 @@ Maven jar plugin with the following configuration:
```
-The documentation and the `.jar` archive for it can then be generated by running `dokka:dokka` and `jar:jar@dokka-jar` goals:
+The documentation and the `.jar` archive for it is then generated by running `dokka:dokka` and `jar:jar@dokka-jar` goals:
```Bash
mvn dokka:dokka jar:jar@dokka-jar
@@ -128,7 +126,7 @@ mvn dokka:dokka jar:jar@dokka-jar
Maven's plugin configuration block can be used to configure Dokka.
-Example of basic configuration that only changes output location of documentation:
+Here is an example of a basic configuration that only changes the output location of your documentation:
```xml
@@ -145,8 +143,8 @@ Example of basic configuration that only changes output location of documentatio
Dokka has many configuration options to tailor your experience.
-Below you will find examples and descriptions for each configuration section. You can also find an example with
-[all configuration options](#complete-configuration) applied at once at the very bottom.
+Below are some examples and detailed descriptions for each configuration section. You can also find an example
+with [all configuration options](#complete-configuration) applied.
### General configuration
@@ -206,23 +204,23 @@ Below you will find examples and descriptions for each configuration section. Yo
Whether to skip documentation generation.
- Default is false.
+ Default: false.
- Display name used to refer to the project/module. Used for ToC, navigation, logging, etc.
- Default is {project.artifactId}.
+ The display name used to refer to the project/module. It's used for the table of contents, navigation, logging, etc.
+ Default: {project.artifactId}.
- Directory to which documentation will be generated.
- Default is {project.basedir}/target/dokka.
+ The directory where documentation is generated.
+ Default: {project.basedir}/target/dokka.
- Whether to fail documentation generation if Dokka has emitted a warning or an error. Will wait until
+ 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 is false.
+ Default: false.
Whether to suppress obvious functions.
@@ -239,7 +237,7 @@ Below you will find examples and descriptions for each configuration section. Yo
- Default is true
+ Default: true
Whether to suppress inherited members that aren't explicitly overridden in a given class.
@@ -248,7 +246,7 @@ Below you will find examples and descriptions for each configuration section. Yo
but cannot suppress synthetic functions such as dataClass.componentN and
dataClass.copy. Use suppressObviousFunctions for that.
- Default is false.
+ Default: false.
Whether to resolve remote files/links over network.
@@ -258,30 +256,30 @@ Below you will find examples and descriptions for each configuration section. Yo
Setting this to true can significantly speed up build times in certain cases,
- but can also worsen documentation quality and user experience, for instance by
+ but can also worsen documentation quality and user experience, for example by
not resolving some dependency's class/member links.
When using offline mode, you can cache fetched files locally and provide them to
Dokka as local paths, see externalDocumentationLinks section.
- Default is false.
+ Default: false.
- Source code roots to be analyzed and documented.
- Accepts directories and individual .kt / .java files.
+ The source code roots to be analyzed and documented.
+ Acceptable inputs are directories and individual .kt / .java files.
- Default is {project.compileSourceRoots}.
+ Default: {project.compileSourceRoots}.
- Set of visibility modifiers that should be documented.
+ 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.
Can be configured on per-package basis.
- Default is PUBLIC.
+ Default: PUBLIC.
@@ -289,82 +287,84 @@ Below you will find examples and descriptions for each configuration section. Yo
after they have been filtered by documentedVisibilities.
This setting works well with failOnWarning.
- Can be overridden on package level.
- Default is false.
+ This can be overridden at package level.
+ Default: false.
Whether to document declarations annotated with @Deprecated.
- Can be overridden on package level.
- Default is false.
+ This can be overridden at package level.
+ Default: false.
Whether to skip packages that contain no visible declarations after various filters have been applied.
- For instance, if skipDeprecated is set to true and your package contains only
- deprecated declarations, it will be considered to be empty.
- Default is true.
+ For example, if skipDeprecated is set to true and your package contains only
+ deprecated declarations, it is considered empty.
+ Default: true.
- Directories or individual files that should be suppressed, meaning declarations from them
- will be not documented.
+ The directories or individual files that should be suppressed, meaning that declarations from them
+ are not documented.
- JDK version to use when generating external documentation links for Java types.
+ The JDK version to use when generating external documentation links for Java types.
- For instance, if you use java.util.UUID from JDK in some public declaration signature,
- and this property is set to 8, Dokka will generate an external documentation link
+ For example, if you use java.util.UUID from JDK in some public declaration signature,
+ and this property is set to 8, Dokka generates an external documentation link
to JDK 8 Javadocs for it.
- Default is JDK 8.
+ Default: JDK 8.
- Kotlin language version
+ The Kotlin language version
used for setting up analysis and @sample
environment.
- By default, the latest language version available to Dokka's embedded compiler will be used.
+ By default, the latest language version available to Dokka's embedded compiler is used.
- Kotlin API version
+ The Kotlin API version
used for setting up analysis and @sample
environment.
- By default, it will be deduced from languageVersion.
+ By default, it is deduced from languageVersion.
Whether to generate external documentation links that lead to API reference
documentation for Kotlin's standard library when declarations from it are used.
- Default is false, meaning links will be generated.
+ Links are generated when `noStdLibLink` is set to false.
+ Default: false.
Whether to generate external documentation links to JDK's Javadocs when declarations from it are used.
The version of JDK Javadocs is determined by jdkVersion property.
- Default is false, meaning links will be generated.
+ Links are generated when `noJdkLink` is set to false.
+ Default: false
- List of Markdown files that contain
+ A list of Markdown files that contain
module and package documentation
- Contents of specified files will be parsed and embedded into documentation as module and package descriptions.
+ The contents of specified files are parsed and embedded into documentation as module and package descriptions.
- Classpath for analysis and interactive samples.
+ The classpath for analysis and interactive samples.
- Useful if some types that come from dependencies are not resolved/picked up automatically.
- Property accepts both .jar and .klib files.
+ This is useful if some types that come from dependencies are not resolved/picked up automatically.
+ The property accepts both .jar and .klib files.
- Default is {project.compileClasspathElements}.
+ Default: {project.compileClasspathElements}.
- List of directories or files that contain sample functions which are referenced via
+ A list of directories or files that contain sample functions which are referenced via
@sample KDoc tag.
@@ -372,9 +372,9 @@ Below you will find examples and descriptions for each configuration section. Yo
### Source link configuration
-Configuration block that allows adding a `source` link to each signature which leads to `path` with a specific line
-number (configurable by setting `lineSuffix`), letting documentation readers find source code for each
-declaration.
+The `sourceLinks` configuration block is where you can add a `source` link to each signature
+that leads to a `remoteUrl` with a specific line number. (The line number is configurable by setting `remoteLineSuffix`).
+This helps readers to find the source code for each declaration.
For an example, see documentation for
[count](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/count.html)
@@ -400,24 +400,24 @@ function from `kotlinx.coroutines`.
- Path to the local source directory. The path must be relative to the root of
+ The path to the local source directory. The path must be relative to the root of the
current module.
- URL of source code hosting service that can be accessed by documentation readers, like GitHub, GitLab,
- Bitbucket, etc. This URL will be used to generate source code links of declarations.
+ 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.
- Suffix used to append source code line number to the URL. This will help readers navigate not only
+ The suffix used to append 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 will be appended to the specified suffix. For instance, if this property is set
- to #L and the line number is 10, resulting URL suffix will be #L10.
+ The number itself is appended to the specified suffix. For example, if this property is set
+ to #L and the line number is 10, the resulting URL suffix is #L10.
Suffixes used by popular services:
@@ -432,13 +432,13 @@ function from `kotlinx.coroutines`.
#### External documentation links configuration
-Configuration block that allows creating links leading to externally hosted documentation of your dependencies.
+The `externalDocumentationLinks` block allows the creation of links that lead to the externally hosted documentation of your dependencies.
-For instance, if you are using types from `kotlinx.serialization`, by default they will be unclickable in your
-documentation, as if unresolved. However, since API reference for `kotlinx.serialization` is also built by Dokka and is
+For example, if you are using types from `kotlinx.serialization`, by default they are be unclickable in your
+documentation, as if they are unresolved. However, since the API reference for `kotlinx.serialization` is also built by Dokka and is
[published on kotlinlang.org](https://kotlinlang.org/api/kotlinx.serialization/), you can configure external
-documentation links for it, allowing Dokka to generate links for used types, making them clickable
-and appear resolved.
+documentation links for it. Thus allowing Dokka to generate links for types, making them clickable
+and resolve successfully.
```xml
@@ -458,27 +458,27 @@ and appear resolved.
- Root URL of documentation to link with. Must contain a trailing slash.
+ The root URL of documentation to link with. It **must** contain a trailing slash.
- Dokka will do its best to automatically find package-list for the given URL,
+ Dokka does its best to automatically find the package-list for the given URL
and link declarations together.
- It automatic resolution fails or if you want to use locally cached files instead,
- consider providing packageListUrl.
+ If automatic resolution fails or if you want to use locally cached files instead,
+ consider providing the packageListUrl.
- Specifies the exact location of a package-list instead of relying on Dokka
- automatically resolving it. Can also be a locally cached file to avoid network calls.
+ The exact location of a package-list. This is an alternative to relying on Dokka
+ automatically resolving it. This can also be a locally cached file to avoid network calls.
### Package options
-Configuration block that allows setting some options for specific packages matched by `matchingRegex`.
+The `packageOptions` configuration block allows you to set some options for specific packages matched by `matchingRegex`.
```xml
@@ -507,25 +507,25 @@ Configuration block that allows setting some options for specific packages match
- Regular expression that is used to match the package.
- Default is any string: .*.
+ The regular expression that is used to match the package.
+ Default: any string: .*.
Whether this package should be skipped when generating documentation.
- Default is false.
+ Default: false.
- List of visibility modifiers that should be documented.
+ A list of visibility modifiers that should be documented.
This can be used if you want to document protected/internal/private declarations within a
specific package, as well as if you want to exclude public declarations and only document internal API.
- Default is PUBLIC.
+ Default: PUBLIC.
Whether to document declarations annotated with @Deprecated.
- Can be set on project/module level.
- Default is false.
+ This can be set on project/module level.
+ Default: false.
@@ -533,13 +533,13 @@ Configuration block that allows setting some options for specific packages match
this package and without KDocs, after they have been filtered by documentedVisibilities.
This setting works well with failOnWarning.
- Default is false.
+ Default: false.
### Complete configuration
-Below you can see all possible configuration options applied at once.
+Below you can see all the possible configuration options applied at the same time.
```xml