aboutsummaryrefslogtreecommitdiff
path: root/docs/topics/runners
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-01-10 13:14:43 +0100
committerGitHub <noreply@github.com>2023-01-10 13:14:43 +0100
commit7544a215fb580ae0c47d1f397334f150d1a1ec65 (patch)
treea30aa62c827e3ba88a498a7406ac57fa7334b270 /docs/topics/runners
parent2161c397e1b1aadcf3d39c8518258e9bdb2b431a (diff)
downloaddokka-7544a215fb580ae0c47d1f397334f150d1a1ec65.tar.gz
dokka-7544a215fb580ae0c47d1f397334f150d1a1ec65.tar.bz2
dokka-7544a215fb580ae0c47d1f397334f150d1a1ec65.zip
Revise documentation (#2728)
Co-authored-by: Sarah Haggarty <sarahhaggarty@users.noreply.github.com>
Diffstat (limited to 'docs/topics/runners')
-rw-r--r--docs/topics/runners/dokka-cli.md859
-rw-r--r--docs/topics/runners/dokka-gradle.md1557
-rw-r--r--docs/topics/runners/dokka-maven.md646
3 files changed, 3062 insertions, 0 deletions
diff --git a/docs/topics/runners/dokka-cli.md b/docs/topics/runners/dokka-cli.md
new file mode 100644
index 00000000..fa8fa459
--- /dev/null
+++ b/docs/topics/runners/dokka-cli.md
@@ -0,0 +1,859 @@
+[//]: # (title: CLI)
+
+If for some reason you cannot use [Gradle](dokka-gradle.md) or [Maven](dokka-maven.md) build tools, Dokka has
+a command line (CLI) runner for generating documentation.
+
+In comparison, it has the same, if not more, capabilities as the Gradle plugin for Dokka. Although it is considerably more
+difficult to set up as there is no autoconfiguration, especially in multiplatform and multi-module environments.
+
+## Get started
+
+The CLI runner is published to Maven Central as a separate runnable artifact.
+
+You can find it on [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-cli/%dokkaVersion%) or by browsing
+[maven central repository directories](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-cli/%dokkaVersion%) directly.
+
+With the `dokka-cli-%dokkaVersion%.jar` file saved on your computer, run it with the `-help` option to see all
+available configuration options and their description:
+
+```Bash
+java -jar dokka-cli-%dokkaVersion%.jar -help
+```
+
+It also works for some nested options, such as `-sourceSet`:
+
+```Bash
+java -jar dokka-cli-%dokkaVersion%.jar -sourceSet -help
+```
+
+## Generate documentation
+
+### Prerequisites
+
+Since there is no build tool to manage dependencies, you have to provide dependency `.jar` files yourself.
+
+Listed below are the dependencies that you need for any output format:
+
+| **Group** | **Artifact** | **Version** | **Link** |
+|-----------------------|----------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
+| `org.jetbrains.dokka` | `dokka-base` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-base/%dokkaVersion%) |
+| `org.jetbrains.dokka` | `dokka-analysis` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis/%dokkaVersion%) |
+| `org.jetbrains.dokka` | `kotlin-analysis-compiler` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler/%dokkaVersion%) |
+| `org.jetbrains.dokka` | `kotlin-analysis-intellij` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij/%dokkaVersion%) |
+
+Below are the additional dependencies that you need for [HTML](dokka-html.md) output format:
+
+| **Group** | **Artifact** | **Version** | **Link** |
+|-------------------------|--------------------|-------------|--------------------------------------------------------------------------------------------------|
+| `org.jetbrains.kotlinx` | `kotlinx-html-jvm` | 0.8.0 | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-html-jvm/0.8.0) |
+| `org.freemarker` | `freemarker` | 2.3.31 | [mvnrepository](https://mvnrepository.com/artifact/org.freemarker/freemarker/2.3.31) |
+
+
+### Run with command line options
+
+You can pass command line options to configure the CLI runner.
+
+At the very least you need to provide the following options:
+
+* `-pluginsClasspath` - a list of absolute/relative paths to downloaded dependencies, separated by semi-colons `;`
+* `-sourceSet` - an absolute path to code sources to generate documentation for
+* `-outputDir` - an absolute/relative path of the documentation output directory
+
+```Bash
+java -jar dokka-cli-%dokkaVersion%.jar \
+ -pluginsClasspath "./dokka-base-%dokkaVersion%.jar;./dokka-analysis-%dokkaVersion%.jar;./kotlin-analysis-intellij-%dokkaVersion%.jar;./kotlin-analysis-compiler-%dokkaVersion%.jar;./kotlinx-html-jvm-0.8.0.jar;./freemarker-2.3.31.jar" \
+ -sourceSet "-src /home/myCoolProject/src/main/kotlin" \
+ -outputDir "./dokka/html"
+```
+
+> Due to an internal class conflict, first pass `kotlin-analysis-intellij` and only then `kotlin-analysis-compiler`.
+> Otherwise you may see obscure exceptions, such as `NoSuchFieldError`.
+>
+{type="note"}
+
+Executing the given example generates documentation in [HTML](dokka-html.md) output format.
+
+See [Command line options](#command-line-options) for more configuration details.
+
+### Run with JSON configuration
+
+It's possible to configure the CLI runner with JSON. In this case, you need to provide an
+absolute/relative path to the JSON configuration file as the first and only argument.
+All other configuration options are parsed from it.
+
+```Bash
+java -jar dokka-cli-%dokkaVersion%.jar dokka-configuration.json
+```
+
+At the very least, you need the following JSON configuration file:
+
+```json
+{
+ "outputDir": "./dokka/html",
+ "sourceSets": [
+ {
+ "sourceSetID": {
+ "scopeId": "moduleName",
+ "sourceSetName": "main"
+ },
+ "sourceRoots": [
+ "/home/myCoolProject/src/main/kotlin"
+ ]
+ }
+ ],
+ "pluginsClasspath": [
+ "./dokka-base-%dokkaVersion%.jar",
+ "./kotlinx-html-jvm-0.8.0.jar",
+ "./dokka-analysis-%dokkaVersion%.jar",
+ "./kotlin-analysis-intellij-%dokkaVersion%.jar",
+ "./kotlin-analysis-compiler-%dokkaVersion%.jar",
+ "./freemarker-2.3.31.jar"
+ ]
+}
+```
+
+> Due to an internal class conflict, first pass `kotlin-analysis-intellij` and only then `kotlin-analysis-compiler`.
+> Otherwise you may see obscure exceptions, such as `NoSuchFieldError`.
+>
+{type="note"}
+
+See [JSON configuration options](#json-configuration) for more details.
+
+### Other output formats
+
+By default, the `dokka-base` artifact contains the [HTML](dokka-html.md) output format only.
+
+All other output formats are implemented as [Dokka plugins](dokka-plugins.md). In order to use them, you have to put them
+on the plugins classpath.
+
+For example, if you want to generate documentation in the experimental [GFM](dokka-markdown.md#gfm) output format, you need to download and
+pass [gfm-plugin's JAR](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin/%dokkaVersion%) into
+the `pluginsClasspath` configuration option.
+
+Via command line options:
+
+```Shell
+java -jar dokka-cli-%dokkaVersion%.jar \
+ -pluginsClasspath "./dokka-base-%dokkaVersion%.jar;...;./gfm-plugin-%dokkaVersion%.jar" \
+ ...
+```
+
+Via JSON configuration:
+
+```json
+{
+ ...
+ "pluginsClasspath": [
+ "./dokka-base-%dokkaVersion%.jar",
+ "...",
+ "./gfm-plugin-%dokkaVersion%.jar"
+ ],
+ ...
+}
+```
+
+With the GFM plugin passed to `pluginsClasspath`, the CLI runner generates documentation in the GFM output format.
+
+For more information, see [Markdown](dokka-markdown.md) and [Javadoc](dokka-javadoc.md#generate-javadoc-documentation) pages.
+
+## Command line options
+
+To see the list of all possible command line options and their detailed description, run:
+
+```Bash
+java -jar dokka-cli-%dokkaVersion%.jar -help
+```
+
+Short summary:
+
+| Option | Description |
+|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `moduleName` | Name of the project/module. |
+| `moduleVersion` | Documented version. |
+| `outputDir` | Output directory path, `./dokka` by default. |
+| `sourceSet` | Configuration for a Dokka source set. Contains nested configuration options. |
+| `pluginsConfiguration` | Configuration for Dokka plugins. |
+| `pluginsClasspath` | List of jars with Dokka plugins and their dependencies. Accepts multiple paths separated by semicolons. |
+| `offlineMode` | Whether to resolve remote files/links over network. |
+| `failOnWarning` | Whether to fail documentation generation if Dokka has emitted a warning or an error. |
+| `delayTemplateSubstitution` | Whether to delay substitution of some elements. Used in incremental builds of multi-module projects. |
+| `noSuppressObviousFunctions` | Whether to suppress obvious functions such as those inherited from `kotlin.Any` and `java.lang.Object`. |
+| `includes` | Markdown files that contain module and package documentation. Accepts multiple values separated by semicolons. |
+| `suppressInheritedMembers` | Whether to suppress inherited members that aren't explicitly overridden in a given class. |
+| `globalPackageOptions` | Global list of package configuration options in format `"matchingRegex,-deprecated,-privateApi,+warnUndocumented,+suppress;+visibility:PUBLIC;..."`. Accepts multiple values separated by semicolons. |
+| `globalLinks` | Global external documentation links in format `{url}^{packageListUrl}`. Accepts multiple values separated by `^^`. |
+| `globalSrcLink` | Global mapping between a source directory and a Web service for browsing the code. Accepts multiple paths separated by semicolons. |
+| `helpSourceSet` | Prints help for the nested `-sourceSet` configuration. |
+| `loggingLevel` | Logging level, possible values: `DEBUG, PROGRESS, INFO, WARN, ERROR`. |
+| `help, h` | Usage info. |
+
+#### Source set options
+
+To see the list of command line options for the nested `-sourceSet` configuration, run:
+
+```Bash
+java -jar dokka-cli-%dokkaVersion%.jar -sourceSet -help
+```
+
+Short summary:
+
+| Option | Description |
+|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `sourceSetName` | Name of the source set. |
+| `displayName` | Display name of the source set, used both internally and externally. |
+| `classpath` | Classpath for analysis and interactive samples. Accepts multiple paths separated by semicolons. |
+| `src` | Source code roots to be analyzed and documented. Accepts multiple paths separated by semicolons. |
+| `dependentSourceSets` | Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple paths separated by semicolons. |
+| `samples` | List of directories or files that contain sample functions. Accepts multiple paths separated by semicolons. |
+| `includes` | Markdown files that contain module and package documentation. Accepts multiple paths separated by semicolons. |
+| `documentedVisibilities` | Visibilities to be documented. Accepts multiple values separated by semicolons. Possible values: `PUBLIC`, `PRIVATE`, `PROTECTED`, `INTERNAL`, `PACKAGE`. |
+| `reportUndocumented` | Whether to report undocumented declarations. |
+| `noSkipEmptyPackages` | Whether to create pages for empty packages. |
+| `skipDeprecated` | Whether to skip deprecated declarations. |
+| `jdkVersion` | Version of JDK to use for linking to JDK Javadocs. |
+| `languageVersion` | Language version used for setting up analysis and samples. |
+| `apiVersion` | Kotlin API version used for setting up analysis and samples. |
+| `noStdlibLink` | Whether to generate links to the Kotlin standard library. |
+| `noJdkLink` | Whether to generate links to JDK Javadocs. |
+| `suppressedFiles` | Paths to files to be suppressed. Accepts multiple paths separated by semicolons. |
+| `analysisPlatform` | Platform used for setting up analysis. |
+| `perPackageOptions` | List of package source set configurations in format `matchingRegexp,-deprecated,-privateApi,+warnUndocumented,+suppress;...`. Accepts multiple values separated by semicolons. |
+| `externalDocumentationLinks` | External documentation links in format `{url}^{packageListUrl}`. Accepts multiple values separated by `^^`. |
+| `srcLink` | Mapping between a source directory and a Web service for browsing the code. Accepts multiple paths separated by semicolons. |
+
+## JSON configuration
+
+Below are some examples and detailed descriptions for each configuration section. You can also find an example
+with [all configuration options](#complete-configuration) applied at the bottom of the page.
+
+### General configuration
+
+```json
+{
+ "moduleName": "Dokka Example",
+ "moduleVersion": null,
+ "outputDir": "./build/dokka/html",
+ "failOnWarning": false,
+ "suppressObviousFunctions": true,
+ "suppressInheritedMembers": false,
+ "offlineMode": false,
+ "includes": [
+ "module.md"
+ ],
+ "sourceLinks": [
+ { "_comment": "Options are described in a separate section" }
+ ],
+ "perPackageOptions": [
+ { "_comment": "Options are described in a separate section" }
+ ],
+ "externalDocumentationLinks": [
+ { "_comment": "Options are described in a separate section" }
+ ],
+ "sourceSets": [
+ { "_comment": "Options are described in a separate section" }
+ ],
+ "pluginsClasspath": [
+ "./dokka-base-%dokkaVersion%.jar",
+ "./kotlinx-html-jvm-0.8.0.jar",
+ "./dokka-analysis-%dokkaVersion%.jar",
+ "./kotlin-analysis-intellij-%dokkaVersion%.jar",
+ "./kotlin-analysis-compiler-%dokkaVersion%.jar",
+ "./freemarker-2.3.31.jar"
+ ]
+}
+```
+
+<deflist collapsible="true">
+ <def title="moduleName">
+ <p>The display name used to refer to the module. It is used for the table of contents, navigation, logging, etc.</p>
+ <p>Default: <code>root</code></p>
+ </def>
+ <def title="moduleVersion">
+ <p>The module version.</p>
+ <p>Default: empty</p>
+ </def>
+ <def title="outputDirectory">
+ <p>The directory to where documentation is generated, regardless of output format.</p>
+ <p>Default: <code>./dokka</code></p>
+ </def>
+ <def title="failOnWarning">
+ <p>
+ 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.
+ </p>
+ <p>This setting works well with <code>reportUndocumented</code></p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="suppressObviousFunctions">
+ <p>Whether to suppress obvious functions.</p>
+ <p>
+ A function is considered to be obvious if it is:
+ <list>
+ <li>
+ Inherited from <code>kotlin.Any</code>, <code>Kotlin.Enum</code>, <code>java.lang.Object</code> or
+ <code>java.lang.Enum</code>, such as <code>equals</code>, <code>hashCode</code>, <code>toString</code>.
+ </li>
+ <li>
+ Synthetic (generated by the compiler) and does not have any documentation, such as
+ <code>dataClass.componentN</code> or <code>dataClass.copy</code>.
+ </li>
+ </list>
+ </p>
+ <p>Default: <code>true</code></p>
+ </def>
+ <def title="suppressInheritedMembers">
+ <p>Whether to suppress inherited members that aren't explicitly overridden in a given class.</p>
+ <p>
+ Note: This can suppress functions such as <code>equals</code> / <code>hashCode</code> / <code>toString</code>,
+ but cannot suppress synthetic functions such as <code>dataClass.componentN</code> and
+ <code>dataClass.copy</code>. Use <code>suppressObviousFunctions</code>
+ for that.
+ </p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="offlineMode">
+ <p>Whether to resolve remote files/links over your network.</p>
+ <p>
+ This includes package-lists used for generating external documentation links.
+ For example, to make classes from the standard library clickable.
+ </p>
+ <p>
+ Setting this to <code>true</code> 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.
+ </p>
+ <p>
+ Note: You can cache fetched files locally and provide them to
+ Dokka as local paths. See <code>externalDocumentationLinks</code> section.
+ </p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="includes">
+ <p>
+ A list of Markdown files that contain
+ <a href="https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation">module and package documentation</a>.
+ </p>
+ <p>The contents of specified files are parsed and embedded into documentation as module and package descriptions.</p>
+ <p>This can be configured on per-package basis.</p>
+ </def>
+ <def title="sourceSets">
+ <p>
+ Individual and additional configuration of Kotlin
+ <a href="https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets">source sets</a>.
+ </p>
+ <p>For a list of possible options, see <a href="#source-set-configuration">source set configuration</a>.</p>
+ </def>
+ <def title="sourceLinks">
+ <p>The global configuration of source links that is applied for all source sets.</p>
+ <p>For a list of possible options, see <a href="#source-link-configuration">source link configuration</a>.</p>
+ </def>
+ <def title="perPackageOptions">
+ <p>The global configuration of matched packages, regardless of the source set they are in.</p>
+ <p>For a list of possible options, see <a href="#per-package-configuration">per-package configuration</a>.</p>
+ </def>
+ <def title="externalDocumentationLinks">
+ <p>The global configuration of external documentation links, regardless of the source set they are used in.</p>
+ <p>For a list of possible options, see <a href="#external-documentation-configuration">external documentation configuration</a>.</p>
+ </def>
+ <def title="pluginsClasspath">
+ <p>A list of JAR files with Dokka plugins and their dependencies.</p>
+ </def>
+</deflist>
+
+### Source set configuration
+
+How to configure Kotlin
+[source sets](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets):
+
+```json
+{
+ "sourceSets": [
+ {
+ "displayName": "jvm",
+ "sourceSetID": {
+ "scopeId": "moduleName",
+ "sourceSetName": "main"
+ },
+ "dependentSourceSets": [
+ {
+ "scopeId": "dependentSourceSetScopeId",
+ "sourceSetName": "dependentSourceSetName"
+ }
+ ],
+ "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"],
+ "reportUndocumented": false,
+ "skipEmptyPackages": true,
+ "skipDeprecated": false,
+ "jdkVersion": 8,
+ "languageVersion": "1.7",
+ "apiVersion": "1.7",
+ "noStdlibLink": false,
+ "noJdkLink": false,
+ "includes": [
+ "module.md"
+ ],
+ "analysisPlatform": "jvm",
+ "sourceRoots": [
+ "/home/ignat/IdeaProjects/dokka-debug-mvn/src/main/kotlin"
+ ],
+ "classpath": [
+ "libs/kotlin-stdlib-%kotlinVersion%.jar",
+ "libs/kotlin-stdlib-common-%kotlinVersion%.jar"
+ ],
+ "samples": [
+ "samples/basic.kt"
+ ],
+ "suppressedFiles": [
+ "src/main/kotlin/org/jetbrains/dokka/Suppressed.kt"
+ ],
+ "sourceLinks": [
+ { "_comment": "Options are described in a separate section" }
+ ],
+ "perPackageOptions": [
+ { "_comment": "Options are described in a separate section" }
+ ],
+ "externalDocumentationLinks": [
+ { "_comment": "Options are described in a separate section" }
+ ]
+ }
+ ]
+}
+```
+
+<deflist collapsible="true">
+ <def title="displayName">
+ <p>The display name used to refer to this source set.</p>
+ <p>
+ 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 <code>reportUndocumented</code>).
+ </p>
+ <p>The platform name can be used if you don't have a better alternative.</p>
+ </def>
+ <def title="sourceSetID">
+ <p>The technical ID of the source set</p>
+ </def>
+ <def title="documentedVisibilities">
+ <p>The set of visibility modifiers that should be documented.</p>
+ <p>
+ 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.
+ </p>
+ <p>This can be configured on per-package basis.</p>
+ <p>
+ Possible values:
+ <list>
+ <li><code>PUBLIC</code></li>
+ <li><code>PRIVATE</code></li>
+ <li><code>PROTECTED</code></li>
+ <li><code>INTERNAL</code></li>
+ <li><code>PACKAGE</code></li>
+ </list>
+ </p>
+ <p>Default: <code>PUBLIC</code></p>
+ </def>
+ <def title="reportUndocumented">
+ <p>
+ Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
+ after they have been filtered by <code>documentedVisibilities</code> and other filters.
+ </p>
+ <p>This setting works well with <code>failOnWarning</code>.</p>
+ <p>This can be configured on per-package basis.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="skipEmptyPackages">
+ <p>
+ Whether to skip packages that contain no visible declarations after
+ various filters have been applied.
+ </p>
+ <p>
+ For example, if <code>skipDeprecated</code> is set to <code>true</code> and your package contains only
+ deprecated declarations, it is considered to be empty.
+ </p>
+ <p>Default for CLI runner is <code>false</code>.</p>
+ </def>
+ <def title="skipDeprecated">
+ <p>Whether to document declarations annotated with <code>@Deprecated</code>.</p>
+ <p>This can be configured on per-package basis.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="jdkVersion">
+ <p>The JDK version to use when generating external documentation links for Java types.</p>
+ <p>
+ For example, if you use <code>java.util.UUID</code> in some public declaration signature,
+ and this option is set to <code>8</code>, Dokka generates an external documentation link
+ to <a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html">JDK 8 Javadocs</a> for it.
+ </p>
+ </def>
+ <def title="languageVersion">
+ <p>
+ <a href="https://kotlinlang.org/docs/compatibility-modes.html">The Kotlin language version</a>
+ used for setting up analysis and <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a>
+ environment.
+ </p>
+ </def>
+ <def title="apiVersion">
+ <p>
+ <a href="https://kotlinlang.org/docs/compatibility-modes.html">The Kotlin API version</a>
+ used for setting up analysis and <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a>
+ environment.
+ </p>
+ </def>
+ <def title="noStdlibLink">
+ <p>
+ Whether to generate external documentation links that lead to the API reference
+ documentation of Kotlin's standard library.
+ </p>
+ <p>Note: Links <b>are</b> generated when <code>noStdLibLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="noJdkLink">
+ <p>Whether to generate external documentation links to JDK's Javadocs.</p>
+ <p>The version of JDK Javadocs is determined by the <code>jdkVersion</code> option.</p>
+ <p>Note: Links <b>are</b> generated when <code>noJdkLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="includes">
+ <p>
+ A list of Markdown files that contain
+ <a href="https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation">module and package documentation</a>.
+ </p>
+ <p>The contents of the specified files are parsed and embedded into documentation as module and package descriptions.</p>
+ </def>
+ <def title="analysisPlatform">
+ <p>
+ Platform to be used for setting up code analysis and
+ <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a> environment.
+ </p>
+ <p>
+ Possible values:
+ <list>
+ <li><code>jvm</code></li>
+ <li><code>common</code></li>
+ <li><code>js</code></li>
+ <li><code>native</code></li>
+ </list>
+ </p>
+ </def>
+ <def title="sourceRoots">
+ <p>
+ The source code roots to be analyzed and documented.
+ Acceptable inputs are directories and individual <code>.kt</code> / <code>.java</code> files.
+ </p>
+ </def>
+ <def title="classpath">
+ <p>The classpath for analysis and interactive samples.</p>
+ <p>This is useful if some types that come from dependencies are not resolved/picked up automatically.</p>
+ <p>This option accepts both <code>.jar</code> and <code>.klib</code> files.</p>
+ </def>
+ <def title="samples">
+ <p>
+ A list of directories or files that contain sample functions which are referenced via the
+ <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a> KDoc tag.
+ </p>
+ </def>
+ <def title="suppressedFiles">
+ <p>The files to be suppressed when generating documentation.</p>
+ </def>
+ <def title="sourceLinks">
+ <p>A set of parameters for source links that is applied only for this source set.</p>
+ <p>For a list of possible options, see <a href="#source-link-configuration">source link configuration</a>.</p>
+ </def>
+ <def title="perPackageOptions">
+ <p>A set of parameters specific to matched packages within this source set.</p>
+ <p>For a list of possible options, see <a href="#per-package-configuration">per-package configuration</a>.</p>
+ </def>
+ <def title="externalDocumentationLinks">
+ <p>A set of parameters for external documentation links that is applied only for this source set.</p>
+ <p>For a list of possible options, see <a href="#external-documentation-configuration">external documentation configuration</a>.</p>
+ </def>
+</deflist>
+
+### Source link configuration
+
+The `sourceLinks` configuration block allows you to add a `source` link to each signature
+that leads to the `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 the documentation for the
+[`count()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/count.html)
+function in `kotlinx.coroutines`.
+
+You can configure source links for all source sets together at the same time, or
+[individually](#source-set-configuration):
+
+```json
+{
+ "sourceLinks": [
+ {
+ "localDirectory": "src/main/kotlin",
+ "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
+ "remoteLineSuffix": "#L"
+ }
+ ]
+}
+```
+
+<deflist collapsible="true">
+ <def title="localDirectory">
+ <p>The path to the local source directory.</p>
+ </def>
+ <def title="remoteUrl">
+ <p>
+ 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.
+ </p>
+ </def>
+ <def title="remoteLineSuffix">
+ <p>
+ 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.
+ </p>
+ <p>
+ The number itself is appended to the specified suffix. For example,
+ if this option is set to <code>#L</code> and the line number is 10, the resulting URL suffix
+ is <code>#L10</code>.
+ </p>
+ <p>
+ Suffixes used by popular services:
+ <list>
+ <li>GitHub: <code>#L</code></li>
+ <li>GitLab: <code>#L</code></li>
+ <li>Bitbucket: <code>#lines-</code></li>
+ </list>
+ </p>
+ <p>Default: empty (no suffix)</p>
+ </def>
+</deflist>
+
+### Per-package configuration
+
+The `perPackageOptions` configuration block allows setting some options for specific packages matched by `matchingRegex`.
+
+You can add package configurations for all source sets together at the same time, or
+[individually](#source-set-configuration):
+
+```json
+{
+ "perPackageOptions": [
+ {
+ "matchingRegex": ".*internal.*",
+ "suppress": false,
+ "skipDeprecated": false,
+ "reportUndocumented": false,
+ "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
+ }
+ ]
+}
+```
+
+<deflist collapsible="true">
+ <def title="matchingRegex">
+ <p>The regular expression that is used to match the package.</p>
+ </def>
+ <def title="suppress">
+ <p>Whether this package should be skipped when generating documentation.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="skipDeprecated">
+ <p>Whether to document declarations annotated with <code>@Deprecated</code>.</p>
+ <p>This can be set on project/module level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="reportUndocumented">
+ <p>
+ Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
+ after they have been filtered by <code>documentedVisibilities</code> and other filters.
+ </p>
+ <p>This setting works well with <code>failOnWarning</code>.</p>
+ <p>This can be configured on source set level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="documentedVisibilities">
+ <p>The set of visibility modifiers that should be documented.</p>
+ <p>
+ 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.
+ </p>
+ <p>Can be configured on source set level.</p>
+ <p>Default: <code>PUBLIC</code></p>
+ </def>
+</deflist>
+
+### External documentation configuration
+
+The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of
+your dependencies.
+
+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 documentation for `kotlinx.serialization`
+is 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 from the library, making
+them resolve successfully and clickable.
+
+You can configure external documentation links for all source sets together at the same time, or
+[individually](#source-set-configuration):
+
+```json
+{
+ "externalDocumentationLinks": [
+ {
+ "url": "https://kotlinlang.org/api/kotlinx.serialization/",
+ "packageListUrl": "https://kotlinlang.org/api/kotlinx.serialization/package-list"
+ }
+ ]
+}
+```
+
+<deflist collapsible="true">
+ <def title="url">
+ <p>The root URL of documentation to link to. It <b>must</b> contain a trailing slash.</p>
+ <p>
+ Dokka does its best to automatically find <code>package-list</code> for the given URL,
+ and link declarations together.
+ </p>
+ <p>
+ If automatic resolution fails or if you want to use locally cached files instead,
+ consider setting the <code>packageListUrl</code> option.
+ </p>
+ </def>
+ <def title="packageListUrl">
+ <p>
+ The exact location of a <code>package-list</code>. This is an alternative to relying on Dokka
+ automatically resolving it.
+ </p>
+ <p>
+ Package lists contain information about the documentation and the project itself,
+ such as module and package names.
+ </p>
+ <p>This can also be a locally cached file to avoid network calls.</p>
+ </def>
+</deflist>
+
+### Complete configuration
+
+Below you can see all possible configuration options applied at the same time.
+
+```json
+{
+ "moduleName": "Dokka Example",
+ "moduleVersion": null,
+ "outputDir": "./build/dokka/html",
+ "failOnWarning": false,
+ "suppressObviousFunctions": true,
+ "suppressInheritedMembers": false,
+ "offlineMode": false,
+ "sourceLinks": [
+ {
+ "localDirectory": "src/main/kotlin",
+ "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
+ "remoteLineSuffix": "#L"
+ }
+ ],
+ "externalDocumentationLinks": [
+ {
+ "url": "https://docs.oracle.com/javase/8/docs/api/",
+ "packageListUrl": "https://docs.oracle.com/javase/8/docs/api/package-list"
+ },
+ {
+ "url": "https://kotlinlang.org/api/latest/jvm/stdlib/",
+ "packageListUrl": "https://kotlinlang.org/api/latest/jvm/stdlib/package-list"
+ }
+ ],
+ "perPackageOptions": [
+ {
+ "matchingRegex": ".*internal.*",
+ "suppress": false,
+ "reportUndocumented": false,
+ "skipDeprecated": false,
+ "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
+ }
+ ],
+ "sourceSets": [
+ {
+ "displayName": "jvm",
+ "sourceSetID": {
+ "scopeId": "moduleName",
+ "sourceSetName": "main"
+ },
+ "dependentSourceSets": [
+ {
+ "scopeId": "dependentSourceSetScopeId",
+ "sourceSetName": "dependentSourceSetName"
+ }
+ ],
+ "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"],
+ "reportUndocumented": false,
+ "skipEmptyPackages": true,
+ "skipDeprecated": false,
+ "jdkVersion": 8,
+ "languageVersion": "1.7",
+ "apiVersion": "1.7",
+ "noStdlibLink": false,
+ "noJdkLink": false,
+ "includes": [
+ "module.md"
+ ],
+ "analysisPlatform": "jvm",
+ "sourceRoots": [
+ "/home/ignat/IdeaProjects/dokka-debug-mvn/src/main/kotlin"
+ ],
+ "classpath": [
+ "libs/kotlin-stdlib-%kotlinVersion%.jar",
+ "libs/kotlin-stdlib-common-%kotlinVersion%.jar"
+ ],
+ "samples": [
+ "samples/basic.kt"
+ ],
+ "suppressedFiles": [
+ "src/main/kotlin/org/jetbrains/dokka/Suppressed.kt"
+ ],
+ "sourceLinks": [
+ {
+ "localDirectory": "src/main/kotlin",
+ "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
+ "remoteLineSuffix": "#L"
+ }
+ ],
+ "externalDocumentationLinks": [
+ {
+ "url": "https://docs.oracle.com/javase/8/docs/api/",
+ "packageListUrl": "https://docs.oracle.com/javase/8/docs/api/package-list"
+ },
+ {
+ "url": "https://kotlinlang.org/api/latest/jvm/stdlib/",
+ "packageListUrl": "https://kotlinlang.org/api/latest/jvm/stdlib/package-list"
+ }
+ ],
+ "perPackageOptions": [
+ {
+ "matchingRegex": ".*internal.*",
+ "suppress": false,
+ "reportUndocumented": false,
+ "skipDeprecated": false,
+ "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
+ }
+ ]
+ }
+ ],
+ "pluginsClasspath": [
+ "./dokka-base-%dokkaVersion%.jar",
+ "./kotlinx-html-jvm-0.8.0.jar",
+ "./dokka-analysis-%dokkaVersion%.jar",
+ "./kotlin-analysis-intellij-%dokkaVersion%.jar",
+ "./kotlin-analysis-compiler-%dokkaVersion%.jar",
+ "./freemarker-2.3.31.jar"
+ ],
+ "pluginsConfiguration": [
+ {
+ "fqPluginName": "org.jetbrains.dokka.base.DokkaBase",
+ "serializationFormat": "JSON",
+ "values": "{\"separateInheritedMembers\":false,\"footerMessage\":\"© 2021 pretty good Copyright\"}"
+ }
+ ],
+ "includes": [
+ "module.md"
+ ]
+}
+```
diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md
new file mode 100644
index 00000000..21a42322
--- /dev/null
+++ b/docs/topics/runners/dokka-gradle.md
@@ -0,0 +1,1557 @@
+[//]: # (title: Gradle)
+
+To generate documentation for a Gradle-based project, you can use the
+[Gradle plugin for Dokka](https://plugins.gradle.org/plugin/org.jetbrains.dokka).
+
+It comes with basic autoconfiguration for your project, has convenient [Gradle tasks](#generate-documentation) for
+generating documentation, and provides a great deal of [configuration options](#configuration-options) to
+customize the output.
+
+You can play around with Dokka and see how it can be configured for various projects by visiting our
+[Gradle example projects](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/gradle).
+
+## Apply Dokka
+
+The recommended way of applying the Gradle plugin for Dokka is with the
+[plugins DSL](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block):
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+plugins {
+ id("org.jetbrains.dokka") version "%dokkaVersion%"
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+plugins {
+ id 'org.jetbrains.dokka' version '%dokkaVersion%'
+}
+```
+
+</tab>
+</tabs>
+
+When documenting [multi-project](dokka-gradle.md#multi-project-builds) builds, you need to apply the Gradle plugin for Dokka
+within subprojects as well. You can use `allprojects {}` or `subprojects {}` Gradle configurations to achieve that:
+
+<tabs group="build-script">
+<tab title="Gradle Kotlin DSL" group-key="kotlin">
+
+```kotlin
+subprojects {
+ apply(plugin = "org.jetbrains.dokka")
+}
+```
+
+</tab>
+<tab title="Gradle Groovy DSL" group-key="groovy">
+
+```groovy
+subprojects {
+ apply plugin: 'org.jetbrains.dokka'
+}
+```
+
+</tab>
+</tabs>
+
+See [Configuration examples](#configuration-examples) if you are not sure where to apply Dokka.
+
+> Under the hood, Dokka uses the [Kotlin Gradle plugin](https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin)
+> to perform autoconfiguration of [source sets](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets)
+> for which documentation is to be generated. Make sure to apply the Kotlin Gradle Plugin or
+> [configure source sets](#source-set-configuration) manually.
+>
+{type="note"}
+
+> If you are using Dokka in a
+> [precompiled script plugin](https://docs.gradle.org/current/userguide/custom_plugins.html#sec:precompiled_plugins),
+> you need to add the [Kotlin Gradle plugin](https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin)
+> as a dependency for it to work properly:
+>
+> <tabs group="build-script">
+> <tab title="Kotlin" group-key="kotlin">
+>
+> ```kotlin
+> implementation(kotlin("gradle-plugin", "%kotlinVersion%"))
+> ```
+>
+> </tab>
+> <tab title="Groovy" group-key="groovy">
+>
+> ```groovy
+> implementation 'org.jetbrains.kotlin:kotlin-gradle-plugin:%kotlinVersion%'
+> ```
+>
+> </tab>
+> </tabs>
+>
+{type="note"}
+
+If you cannot use the plugins DSL for some reason, you can use
+[the legacy method](https://docs.gradle.org/current/userguide/plugins.html#sec:old_plugin_application) of applying
+plugins.
+
+## Generate documentation
+
+The Gradle plugin for Dokka comes with [HTML](dokka-html.md), [Markdown](dokka-markdown.md) and [Javadoc](dokka-javadoc.md) output formats
+built in. It adds a number of tasks for generating documentation, both for [single](#single-project-builds)
+and [multi-project](#multi-project-builds) builds.
+
+### Single-project builds
+
+Use the following tasks to build documentation for simple, single-project applications and libraries:
+
+#### Stable formats
+
+| **Task** | **Description** |
+|----------------|-------------------------------------------------------------------------------------|
+| `dokkaHtml` | Generates documentation in [HTML](dokka-html.md) format. |
+
+#### Experimental formats
+
+| **Task** | **Description** |
+|----------------|-------------------------------------------------------------------------------------|
+| `dokkaGfm` | Generates documentation in [GitHub Flavored Markdown](dokka-markdown.md#gfm) format. |
+| `dokkaJavadoc` | Generates documentation in [Javadoc](dokka-javadoc.md) format. |
+| `dokkaJekyll` | Generates documentation in [Jekyll compatible Markdown](dokka-markdown.md#jekyll) format. |
+
+By default, generated documentation is located in the `build/dokka/{format}` directory of your project.
+The output location, among other things, can be [configured](#configuration-examples).
+
+### Multi-project builds
+
+For documenting [multi-project builds](https://docs.gradle.org/current/userguide/multi_project_builds.html), make sure
+that you [apply the Gradle plugin for Dokka](#apply-dokka) within subprojects that you want to generate documentation
+for, as well as in their parent project.
+
+#### MultiModule tasks
+
+`MultiModule` tasks generate documentation for each subproject individually via [`Partial`](#partial-tasks) tasks,
+collect and process all outputs, and produce complete documentation with a common table of contents and resolved
+cross-project references.
+
+Dokka creates the following tasks for **parent** projects automatically:
+
+#### Stable formats
+
+| **Task** | **Description** |
+|--------------------------|------------------------------------------------------------------------|
+| `dokkaHtmlMultiModule` | Generates multi-module documentation in [HTML](dokka-html.md) output format. |
+
+#### Experimental formats
+
+| **Task** | **Description** |
+|--------------------------|---------------------------------------------------------------------------------------------------------|
+| `dokkaGfmMultiModule` | Generates multi-module documentation in [GitHub Flavored Markdown](dokka-markdown.md#gfm) output format. |
+| `dokkaJekyllMultiModule` | Generates multi-module documentation in [Jekyll compatible Markdown](dokka-markdown.md#jekyll) output format. |
+
+> The [Javadoc](dokka-javadoc.md) output format does not have a `MultiModule` task, but a [`Collector`](#collector-tasks) task can
+> be used instead.
+>
+{type="note"}
+
+By default, you can find ready-to-use documentation under `{parentProject}/build/dokka/{format}MultiModule` directory.
+
+#### MultiModule results
+
+Given a project with the following structure:
+
+```text
+parentProject
+ └── childProjectA
+ ├── demo
+ ├── ChildProjectAClass
+ └── childProjectB
+ ├── demo
+ ├── ChildProjectBClass
+```
+
+These pages are generated after running `dokkaHtmlMultiModule`:
+
+![Screenshot for output of dokkaHtmlMultiModule task](dokkaHtmlMultiModule-example.png){width=600}
+
+See our [multi-module project example](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example)
+for more details.
+
+#### Collector tasks
+
+Similar to `MultiModule` tasks, `Collector` tasks are created for each parent project: `dokkaHtmlCollector`,
+`dokkaGfmCollector`, `dokkaJavadocCollector` and `dokkaJekyllCollector`.
+
+A `Collector` task executes the corresponding [single-project task](#single-project-builds) for each subproject (for
+example,
+`dokkaHtml`), and merges all outputs into a single virtual project.
+
+The resulting documentation looks as if you have a single-project
+build that contains all declarations from the subprojects.
+
+> Use the `dokkaJavadocCollector` task if you need to create Javadoc documentation for your multi-project build.
+>
+{type="tip"}
+
+#### Collector results
+
+Given a project with the following structure:
+
+```text
+parentProject
+ └── childProjectA
+ ├── demo
+ ├── ChildProjectAClass
+ └── childProjectB
+ ├── demo
+ ├── ChildProjectBClass
+```
+
+These pages are generated after running `dokkaHtmlCollector`:
+
+![Screenshot for output of dokkaHtmlCollector task](dokkaHtmlCollector-example.png){width=800}
+
+See our [multi-module project example](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example)
+for more details.
+
+#### Partial tasks
+
+Each subproject has `Partial` tasks created for it: `dokkaHtmlPartial`,`dokkaGfmPartial`,
+and `dokkaJekyllPartial`.
+
+These tasks are not intended to be run independently, they are called by the parent's
+[MultiModule](#multimodule-tasks) task.
+
+However, you can [configure](#subproject-configuration) `Partial` tasks to customize Dokka for your subprojects.
+
+> Output generated by `Partial` tasks contains unresolved HTML templates and references, so it cannot be used
+> on its own without post-processing done by the parent's [`MultiModule`](#multimodule-tasks) task.
+>
+{type="warning"}
+
+> If you want to generate documentation for a single subproject only, use
+> [single-project tasks](#single-project-builds). For example, `:subprojectName:dokkaHtml`.
+>
+{type="note"}
+
+## Build javadoc.jar
+
+If you want to publish your library to a repository, you may need to provide a `javadoc.jar` file that contains
+API reference documentation of your library.
+
+For example, if you want to publish to [Maven Central](https://central.sonatype.org/), you
+[must](https://central.sonatype.org/publish/requirements/) supply a `javadoc.jar` alongside your project. However,
+not all repositories have that rule.
+
+The Gradle plugin for Dokka does not provide any way to do this out of the box, but it can be achieved with custom Gradle
+tasks. One for generating documentation in [HTML](dokka-html.md) format and another one for [Javadoc](dokka-javadoc.md) format:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+tasks.register<Jar>("dokkaHtmlJar") {
+ dependsOn(tasks.dokkaHtml)
+ from(tasks.dokkaHtml.flatMap { it.outputDirectory })
+ archiveClassifier.set("html-docs")
+}
+
+tasks.register<Jar>("dokkaJavadocJar") {
+ dependsOn(tasks.dokkaJavadoc)
+ from(tasks.dokkaJavadoc.flatMap { it.outputDirectory })
+ archiveClassifier.set("javadoc")
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+tasks.register('dokkaHtmlJar', Jar.class) {
+ dependsOn(dokkaHtml)
+ from(dokkaHtml)
+ archiveClassifier.set("html-docs")
+}
+
+tasks.register('dokkaJavadocJar', Jar.class) {
+ dependsOn(dokkaJavadoc)
+ from(dokkaJavadoc)
+ archiveClassifier.set("javadoc")
+}
+```
+
+</tab>
+</tabs>
+
+> If you publish your library to Maven Central, you can use services like [javadoc.io](https://javadoc.io/) to
+> host your library's API documentation for free and without any setup. It takes documentation pages straight
+> from the `javadoc.jar`. It works well with the HTML format as demonstrated in
+> [this example](https://javadoc.io/doc/com.trib3/server/latest/index.html).
+>
+{type="tip"}
+
+## Configuration examples
+
+Depending on the type of project that you have, the way you apply and configure Dokka differs slightly. However,
+[configuration options](#configuration-options) themselves are the same, regardless of the type of your project.
+
+For simple and flat projects with a single `build.gradle.kts` or `build.gradle` file found in the root of your project,
+see [Single-project configuration](#single-project-configuration).
+
+For a more complex build with subprojects and multiple nested `build.gradle.kts` or `build.gradle` files,
+see [Multi-project configuration](#multi-project-configuration).
+
+### Single-project configuration
+
+Single-project builds usually have only one `build.gradle.kts` or `build.gradle` file in the root of the project,
+and typically have the following structure:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+Single platform:
+
+```text
+.
+├── build.gradle.kts
+└── src
+ └── main
+ └── kotlin
+ └── HelloWorld.kt
+```
+
+Multiplatform:
+
+```text
+.
+├── build.gradle.kts
+└── src
+ └── commonMain
+ └── kotlin
+ └── Common.kt
+ └── jvmMain
+ └── kotlin
+ └── JvmUtils.kt
+ └── nativeMain
+ └── kotlin
+ └── NativeUtils.kt
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+Single platform:
+
+```text
+.
+├── build.gradle
+└── src
+ └── main
+ └── kotlin
+ └── HelloWorld.kt
+```
+
+Multiplatform:
+
+```text
+.
+├── build.gradle
+└── src
+ └── commonMain
+ └── kotlin
+ └── Common.kt
+ └── jvmMain
+ └── kotlin
+ └── JvmUtils.kt
+ └── nativeMain
+ └── kotlin
+ └── NativeUtils.kt
+```
+
+</tab>
+</tabs>
+
+In such projects, you need to apply Dokka and its configuration in the root `build.gradle.kts` or `build.gradle` file.
+
+You can configure tasks and output formats individually:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+Inside `./build.gradle.kts`:
+
+```kotlin
+plugins {
+ id("org.jetbrains.dokka") version "%dokkaVersion%"
+}
+
+tasks.dokkaHtml {
+ outputDirectory.set(buildDir.resolve("documentation/html"))
+}
+
+tasks.dokkaGfm {
+ outputDirectory.set(buildDir.resolve("documentation/markdown"))
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+Inside `./build.gradle`:
+
+```groovy
+plugins {
+ id 'org.jetbrains.dokka' version '%dokkaVersion%'
+}
+
+dokkaHtml {
+ outputDirectory.set(file("build/documentation/html"))
+}
+
+dokkaGfm {
+ outputDirectory.set(file("build/documentation/markdown"))
+}
+```
+
+</tab>
+</tabs>
+
+Or you can configure all tasks and output formats at the same time:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+Inside `./build.gradle.kts`:
+
+```kotlin
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+
+plugins {
+ id("org.jetbrains.dokka") version "%dokkaVersion%"
+}
+
+// Configure all single-project Dokka tasks at the same time,
+// such as dokkaHtml, dokkaJavadoc and dokkaGfm.
+tasks.withType<DokkaTask>().configureEach {
+ dokkaSourceSets.configureEach {
+ documentedVisibilities.set(
+ setOf(
+ Visibility.PUBLIC,
+ Visibility.PROTECTED,
+ )
+ )
+
+ perPackageOption {
+ matchingRegex.set(".*internal.*")
+ suppress.set(true)
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+Inside `./build.gradle`:
+
+```groovy
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+
+plugins {
+ id 'org.jetbrains.dokka' version '%dokkaVersion%'
+}
+
+// Configure all single-project Dokka tasks at the same time,
+// such as dokkaHtml, dokkaJavadoc and dokkaGfm.
+tasks.withType(DokkaTask.class) {
+ dokkaSourceSets.configureEach {
+ documentedVisibilities.set([
+ DokkaConfiguration.Visibility.PUBLIC,
+ DokkaConfiguration.Visibility.PROTECTED
+ ])
+
+ perPackageOption {
+ matchingRegex.set(".*internal.*")
+ suppress.set(true)
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
+
+### Multi-project configuration
+
+Gradle's [multi-project builds](https://docs.gradle.org/current/userguide/multi_project_builds.html) are more complex
+in structure and configuration. They usually have multiple nested `build.gradle.kts` or `build.gradle` files, and
+typically have the following structure:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```text
+.
+├── build.gradle.kts
+├── settings.gradle.kts
+├── subproject-A
+ └── build.gradle.kts
+ └── src
+ └── main
+ └── kotlin
+ └── HelloFromA.kt
+├── subproject-B
+ └── build.gradle.kts
+ └── src
+ └── main
+ └── kotlin
+ └── HelloFromB.kt
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```text
+.
+├── build.gradle
+├── settings.gradle
+├── subproject-A
+ └── build.gradle
+ └── src
+ └── main
+ └── kotlin
+ └── HelloFromA.kt
+├── subproject-B
+ └── build.gradle
+ └── src
+ └── main
+ └── kotlin
+ └── HelloFromB.kt
+```
+
+</tab>
+</tabs>
+
+In this case, there are multiple ways of applying and configuring Dokka.
+
+#### Subproject configuration
+
+To configure subprojects in a multi-project build, you need to configure [`Partial`](#partial-tasks) tasks.
+
+You can configure all subprojects at the same time in the root `build.gradle.kts` or `build.gradle` file,
+using Gradle's `allprojects {}` or `subprojects {}` configuration blocks:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+In the root `./build.gradle.kts`:
+
+```kotlin
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
+
+plugins {
+ id("org.jetbrains.dokka") version "%dokkaVersion%"
+}
+
+subprojects {
+ apply(plugin = "org.jetbrains.dokka")
+
+ // configure only the HTML task
+ tasks.dokkaHtmlPartial {
+ outputDirectory.set(buildDir.resolve("docs/partial"))
+ }
+
+ // configure all format tasks at once
+ tasks.withType<DokkaTaskPartial>().configureEach {
+ dokkaSourceSets.configureEach {
+ includes.from("README.md")
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+In the root `./build.gradle`:
+
+```groovy
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
+
+plugins {
+ id 'org.jetbrains.dokka' version '%dokkaVersion%'
+}
+
+subprojects {
+ apply plugin: 'org.jetbrains.dokka'
+
+ // configure only the HTML task
+ dokkaHtmlPartial {
+ outputDirectory.set(file("build/docs/partial"))
+ }
+
+ // configure all format tasks at once
+ tasks.withType(DokkaTaskPartial.class) {
+ dokkaSourceSets.configureEach {
+ includes.from("README.md")
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
+
+Alternatively, you can apply and configure Dokka within subprojects individually.
+
+For example, to have specific settings for the `subproject-A` subproject only, you need to apply the following code
+inside `./subproject-A/build.gradle.kts`:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+Inside `./subproject-A/build.gradle.kts`:
+
+```kotlin
+apply(plugin = "org.jetbrains.dokka")
+
+// configuration for subproject-A only.
+tasks.dokkaHtmlPartial {
+ outputDirectory.set(buildDir.resolve("docs/partial"))
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+Inside `./subproject-A/build.gradle`:
+
+```groovy
+apply plugin: 'org.jetbrains.dokka'
+
+// configuration for subproject-A only.
+dokkaHtmlPartial {
+ outputDirectory.set(file("build/docs/partial"))
+}
+```
+
+</tab>
+</tabs>
+
+#### Parent project configuration
+
+If you want to configure something which is universal across all documentation and does not belong to the
+subprojects - in other words, it's a property of the parent project - you need to configure the
+[`MultiModule`](#multimodule-tasks) tasks.
+
+For example, if you want to change the name of your project which is used in the header of the HTML documentation,
+you need to apply the following inside the root `build.gradle.kts` or `build.gradle` file:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+In the root `./build.gradle.kts` file:
+
+```kotlin
+plugins {
+ id("org.jetbrains.dokka") version "%dokkaVersion%"
+}
+
+tasks.dokkaHtmlMultiModule {
+ moduleName.set("WHOLE PROJECT NAME USED IN THE HEADER")
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+In the root `./build.gradle` file:
+
+```groovy
+plugins {
+ id 'org.jetbrains.dokka' version '%dokkaVersion%'
+}
+
+dokkaHtmlMultiModule {
+ moduleName.set("WHOLE PROJECT NAME USED IN THE HEADER")
+}
+```
+
+</tab>
+</tabs>
+
+## Configuration options
+
+Dokka has many configuration options to tailor your and your reader's experience.
+
+Below are some examples and detailed descriptions for each configuration section. You can also find an example
+with [all configuration options](#complete-configuration) applied at the bottom of the page.
+
+See [Configuration examples](#configuration-examples) for more details on where to apply configuration blocks and how.
+
+### General configuration
+
+Here is an example of general configuration of any Dokka task, regardless of source set or package:
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+import org.jetbrains.dokka.gradle.DokkaTask
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType<DokkaTask>().configureEach {
+ moduleName.set(project.name)
+ moduleVersion.set(project.version.toString())
+ outputDirectory.set(buildDir.resolve("dokka/$name"))
+ failOnWarning.set(false)
+ suppressObviousFunctions.set(true)
+ suppressInheritedMembers.set(false)
+ offlineMode.set(false)
+
+ // ..
+ // source set configuration section
+ // ..
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+import org.jetbrains.dokka.gradle.DokkaTask
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType(DokkaTask.class) {
+ moduleName.set(project.name)
+ moduleVersion.set(project.version.toString())
+ outputDirectory.set(file("build/dokka/$name"))
+ failOnWarning.set(false)
+ suppressObviousFunctions.set(true)
+ suppressInheritedMembers.set(false)
+ offlineMode.set(false)
+
+ // ..
+ // source set configuration section
+ // ..
+}
+```
+
+</tab>
+</tabs>
+
+<deflist collapsible="true">
+ <def title="moduleName">
+ <p>The display name used to refer to the module. It is used for the table of contents, navigation, logging, etc.</p>
+ <p>If set for a single-project build or a <code>MultiModule</code> task, it is used as the project name.</p>
+ <p>Default: Gradle project name</p>
+ </def>
+ <def title="moduleVersion">
+ <p>
+ The module version. If set for a single-project build or a <code>MultiModule</code> task, it is used as the
+ project version.
+ </p>
+ <p>Default: Gradle project version</p>
+ </def>
+ <def title="outputDirectory">
+ <p>The directory to where documentation is generated, regardless of format. It can be set on a per-task basis.</p>
+ <p>
+ The default is <code>{project}/{buildDir}/{format}</code>, where <code>{format}</code> is the task name with
+ the "dokka" prefix removed. For the <code>dokkaHtmlMultiModule</code> task, it is
+ <code>project/buildDir/htmlMultiModule</code>.
+ </p>
+ </def>
+ <def title="failOnWarning">
+ <p>
+ 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.
+ </p>
+ <p>This setting works well with <code>reportUndocumented</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="suppressObviousFunctions">
+ <p>Whether to suppress obvious functions.</p>
+ <p>
+ A function is considered to be obvious if it is:
+ <list>
+ <li>
+ Inherited from <code>kotlin.Any</code>, <code>Kotlin.Enum</code>, <code>java.lang.Object</code> or
+ <code>java.lang.Enum</code>, such as <code>equals</code>, <code>hashCode</code>, <code>toString</code>.
+ </li>
+ <li>
+ Synthetic (generated by the compiler) and does not have any documentation, such as
+ <code>dataClass.componentN</code> or <code>dataClass.copy</code>.
+ </li>
+ </list>
+ </p>
+ <p>Default: <code>true</code></p>
+ </def>
+ <def title="suppressInheritedMembers">
+ <p>Whether to suppress inherited members that aren't explicitly overridden in a given class.</p>
+ <p>
+ Note: This can suppress functions such as <code>equals</code> / <code>hashCode</code> / <code>toString</code>,
+ but cannot suppress synthetic functions such as <code>dataClass.componentN</code> and
+ <code>dataClass.copy</code>. Use <code>suppressObviousFunctions</code>
+ for that.
+ </p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="offlineMode">
+ <p>Whether to resolve remote files/links over your network.</p>
+ <p>
+ This includes package-lists used for generating external documentation links.
+ For example, to make classes from the standard library clickable.
+ </p>
+ <p>
+ Setting this to <code>true</code> 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.
+ </p>
+ <p>
+ Note: You can cache fetched files locally and provide them to
+ Dokka as local paths. See <code>externalDocumentationLinks</code> section.
+ </p>
+ <p>Default: <code>false</code></p>
+ </def>
+</deflist>
+
+### Source set configuration
+
+Dokka allows configuring some options for
+[Kotlin source sets](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets):
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.Platform
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType<DokkaTask>().configureEach {
+ // ..
+ // general configuration section
+ // ..
+
+ // configuration exclusive to the 'linux' source set
+ named("linux") {
+ dependsOn("native")
+ sourceRoots.from(file("linux/src"))
+ }
+
+ dokkaSourceSets.configureEach {
+ suppress.set(false)
+ displayName.set(name)
+ documentedVisibilities.set(setOf(Visibility.PUBLIC))
+ reportUndocumented.set(false)
+ skipEmptyPackages.set(true)
+ skipDeprecated.set(false)
+ suppressGeneratedFiles.set(true)
+ jdkVersion.set(8)
+ languageVersion.set("1.7")
+ apiVersion.set("1.7")
+ noStdlibLink.set(false)
+ noJdkLink.set(false)
+ noAndroidSdkLink.set(false)
+ includes.from(project.files(), "packages.md", "extra.md")
+ platform.set(Platform.DEFAULT)
+ sourceRoots.from(file("src"))
+ classpath.from(project.files(), file("libs/dependency.jar"))
+ samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt")
+
+ sourceLink {
+ // Source link section
+ }
+ externalDocumentationLink {
+ // External documentation link section
+ }
+ perPackageOption {
+ // Package options section
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.Platform
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType(DokkaTask.class) {
+ // ..
+ // general configuration section
+ // ..
+
+ // configuration exclusive to the 'linux' source set
+ named("linux") {
+ dependsOn("native")
+ sourceRoots.from(file("linux/src"))
+ }
+
+ dokkaSourceSets.configureEach {
+ suppress.set(false)
+ displayName.set(name)
+ documentedVisibilities.set([Visibility.PUBLIC])
+ reportUndocumented.set(false)
+ skipEmptyPackages.set(true)
+ skipDeprecated.set(false)
+ suppressGeneratedFiles.set(true)
+ jdkVersion.set(8)
+ languageVersion.set("1.7")
+ apiVersion.set("1.7")
+ noStdlibLink.set(false)
+ noJdkLink.set(false)
+ noAndroidSdkLink.set(false)
+ includes.from(project.files(), "packages.md", "extra.md")
+ platform.set(Platform.DEFAULT)
+ sourceRoots.from(file("src"))
+ classpath.from(project.files(), file("libs/dependency.jar"))
+ samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt")
+
+ sourceLink {
+ // Source link section
+ }
+ externalDocumentationLink {
+ // External documentation link section
+ }
+ perPackageOption {
+ // Package options section
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
+
+<deflist collapsible="true">
+ <def title="suppress">
+ <p>Whether this source set should be skipped when generating documentation.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="displayName">
+ <p>The display name used to refer to this source set.</p>
+ <p>
+ The name is used both externally (for example, as source set name visible to documentation readers) and
+ internally (for example, for logging messages of <code>reportUndocumented</code>).
+ </p>
+ <p>By default, the value is deduced from information provided by the Kotlin Gradle plugin.</p>
+ </def>
+ <def title="documentedVisibilities">
+ <p>The set of visibility modifiers that should be documented.</p>
+ <p>
+ 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.
+ </p>
+ <p>This can be configured on per-package basis.</p>
+ <p>Default: <code>DokkaConfiguration.Visibility.PUBLIC</code></p>
+ </def>
+ <def title="reportUndocumented">
+ <p>
+ Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
+ after they have been filtered by <code>documentedVisibilities</code> and other filters.
+ </p>
+ <p>This setting works well with <code>failOnWarning</code>.</p>
+ <p>This can be configured on per-package basis.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="skipEmptyPackages">
+ <p>
+ Whether to skip packages that contain no visible declarations after
+ various filters have been applied.
+ </p>
+ <p>
+ For example, if <code>skipDeprecated</code> is set to <code>true</code> and your package contains only
+ deprecated declarations, it is considered to be empty.
+ </p>
+ <p>Default: <code>true</code></p>
+ </def>
+ <def title="skipDeprecated">
+ <p>Whether to document declarations annotated with <code>@Deprecated</code>.</p>
+ <p>This can be configured on per-package basis.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="suppressGeneratedFiles">
+ <p>Whether to document/analyze generated files.</p>
+ <p>
+ Generated files are expected to be present under the <code>{project}/{buildDir}/generated</code> directory.
+ </p>
+ <p>
+ If set to <code>true</code>, it effectively adds all files from that directory to the
+ <code>suppressedFiles</code> option, so you can configure it manually.
+ </p>
+ <p>Default: <code>true</code></p>
+ </def>
+ <def title="jdkVersion">
+ <p>The JDK version to use when generating external documentation links for Java types.</p>
+ <p>
+ For example, if you use <code>java.util.UUID</code> in some public declaration signature,
+ and this option is set to <code>8</code>, Dokka generates an external documentation link
+ to <a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html">JDK 8 Javadocs</a> for it.
+ </p>
+ <p>Default: JDK 8</p>
+ </def>
+ <def title="languageVersion">
+ <p>
+ <a href="https://kotlinlang.org/docs/compatibility-modes.html">The Kotlin language version</a>
+ used for setting up analysis and <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a>
+ environment.
+ </p>
+ <p>By default, the latest language version available to Dokka's embedded compiler is used.</p>
+ </def>
+ <def title="apiVersion">
+ <p>
+ <a href="https://kotlinlang.org/docs/compatibility-modes.html">The Kotlin API version</a>
+ used for setting up analysis and <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a>
+ environment.
+ </p>
+ <p>By default, it is deduced from <code>languageVersion</code>.</p>
+ </def>
+ <def title="noStdlibLink">
+ <p>
+ Whether to generate external documentation links that lead to the API reference
+ documentation of Kotlin's standard library.
+ </p>
+ <p>Note: Links <b>are</b> generated when <code>noStdLibLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="noJdkLink">
+ <p>Whether to generate external documentation links to JDK's Javadocs.</p>
+ <p>The version of JDK Javadocs is determined by the <code>jdkVersion</code> option.</p>
+ <p>Note: Links <b>are</b> generated when <code>noJdkLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="noAndroidSdkLink">
+ <p>Whether to generate external documentation links to the Android SDK API reference</p>
+ <p>This is only relevant in Android projects, ignored otherwise.</p>
+ <p>Note: Links <b>are</b> generated when <code>noAndroidSdkLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="includes">
+ <p>
+ A list of Markdown files that contain
+ <a href="https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation">module and package documentation</a>.
+ </p>
+ <p>The contents of the specified files are parsed and embedded into documentation as module and package descriptions.</p>
+ <p>
+ See <a href="https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-gradle-example">Dokka gradle example</a>
+ for an example of what it looks like and how to use it.
+ </p>
+ </def>
+ <def title="platform">
+ <p>
+ The platform to be used for setting up code analysis and
+ <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a> environment.
+ </p>
+ <p>The default value is deduced from information provided by the Kotlin Gradle plugin.</p>
+ </def>
+ <def title="sourceRoots">
+ <p>
+ The source code roots to be analyzed and documented.
+ Acceptable inputs are directories and individual <code>.kt</code> / <code>.java</code> files.
+ </p>
+ <p>By default, source roots are deduced from information provided by the Kotlin Gradle plugin.</p>
+ </def>
+ <def title="classpath">
+ <p>The classpath for analysis and interactive samples.</p>
+ <p>This is useful if some types that come from dependencies are not resolved/picked up automatically.</p>
+ <p>This option accepts both <code>.jar</code> and <code>.klib</code> files.</p>
+ <p>By default, classpath is deduced from information provided by the Kotlin Gradle plugin.</p>
+ </def>
+ <def title="samples">
+ <p>
+ A list of directories or files that contain sample functions which are referenced via the
+ <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a> KDoc tag.
+ </p>
+ </def>
+</deflist>
+
+### Source link configuration
+
+The `sourceLinks` configuration block allows you to add a `source` link to each signature
+that leads to the `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 the documentation for the
+[`count()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/count.html)
+function in `kotlinx.coroutines`.
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+import org.jetbrains.dokka.gradle.DokkaTask
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType<DokkaTask>().configureEach {
+ // ..
+ // general configuration section
+ // ..
+
+ dokkaSourceSets.configureEach {
+ // ..
+ // source set configuration section
+ // ..
+
+ sourceLink {
+ localDirectory.set(projectDir.resolve("src"))
+ remoteUrl.set(URL("https://github.com/kotlin/dokka/tree/master/src"))
+ remoteLineSuffix.set("#L")
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+import org.jetbrains.dokka.gradle.DokkaTask
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType(DokkaTask.class) {
+ // ..
+ // general configuration section
+ // ..
+
+ dokkaSourceSets.configureEach {
+ // ..
+ // source set configuration section
+ // ..
+
+ sourceLink {
+ localDirectory.set(file("src"))
+ remoteUrl.set(new URL("https://github.com/kotlin/dokka/tree/master/src"))
+ remoteLineSuffix.set("#L")
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
+
+<deflist collapsible="true">
+ <def title="localDirectory">
+ <p>
+ The path to the local source directory. The path must be relative to the root of
+ the current project.
+ </p>
+ </def>
+ <def title="remoteUrl">
+ <p>
+ 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.
+ </p>
+ </def>
+ <def title="remoteLineSuffix">
+ <p>
+ 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.
+ </p>
+ <p>
+ The number itself is appended to the specified suffix. For example,
+ if this option is set to <code>#L</code> and the line number is 10, the resulting URL suffix
+ is <code>#L10</code>.
+ </p>
+ <p>
+ Suffixes used by popular services:
+ <list>
+ <li>GitHub: <code>#L</code></li>
+ <li>GitLab: <code>#L</code></li>
+ <li>Bitbucket: <code>#lines-</code></li>
+ </list>
+ </p>
+ <p>Default: <code>#L</code></p>
+ </def>
+</deflist>
+
+### Package options
+
+The `perPackageOption` configuration block allows setting some options for specific packages matched by `matchingRegex`.
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.gradle.DokkaTask
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType<DokkaTask>().configureEach {
+ // ..
+ // general configuration section
+ // ..
+
+ dokkaSourceSets.configureEach {
+ // ..
+ // source set configuration section
+ // ..
+
+ perPackageOption {
+ matchingRegex.set(".*api.*")
+ suppress.set(false)
+ skipDeprecated.set(false)
+ reportUndocumented.set(false)
+ documentedVisibilities.set(setOf(Visibility.PUBLIC))
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.gradle.DokkaTask
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType(DokkaTask.class) {
+ // ..
+ // general configuration section
+ // ..
+
+ dokkaSourceSets.configureEach {
+ // ..
+ // Source set configuration section
+ // ..
+
+ perPackageOption {
+ matchingRegex.set(".*api.*")
+ suppress.set(false)
+ skipDeprecated.set(false)
+ reportUndocumented.set(false)
+ documentedVisibilities.set([Visibility.PUBLIC])
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
+
+<deflist collapsible="true">
+ <def title="matchingRegex">
+ <p>The regular expression that is used to match the package.</p>
+ <p>Default: <code>.*</code></p>
+ </def>
+ <def title="suppress">
+ <p>Whether this package should be skipped when generating documentation.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="skipDeprecated">
+ <p>Whether to document declarations annotated with <code>@Deprecated</code>.</p>
+ <p>This can be configured on source set level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="reportUndocumented">
+ <p>
+ Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
+ after they have been filtered by <code>documentedVisibilities</code> and other filters.
+ </p>
+ <p>This setting works well with <code>failOnWarning</code>.</p>
+ <p>This can be configured on source set level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="documentedVisibilities">
+ <p>The set of visibility modifiers that should be documented.</p>
+ <p>
+ 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.
+ </p>
+ <p>This can be configured on source set level.</p>
+ <p>Default: <code>DokkaConfiguration.Visibility.PUBLIC</code></p>
+ </def>
+</deflist>
+
+### External documentation links configuration
+
+The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of
+your dependencies.
+
+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 documentation for `kotlinx.serialization`
+is 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 from the library, making
+them resolve successfully and clickable.
+
+By default, external documentation links for Kotlin standard library, JDK, Android SDK and AndroidX are configured.
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+import org.jetbrains.dokka.gradle.DokkaTask
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType<DokkaTask>().configureEach {
+ // ..
+ // general configuration section
+ // ..
+
+ dokkaSourceSets.configureEach {
+ // ..
+ // source set configuration section
+ // ..
+
+ externalDocumentationLink {
+ url.set(URL("https://kotlinlang.org/api/kotlinx.serialization/"))
+ packageListUrl.set(
+ rootProject.projectDir.resolve("serialization.package.list").toURL()
+ )
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+import org.jetbrains.dokka.gradle.DokkaTask
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType(DokkaTask.class) {
+ // ..
+ // general configuration section
+ // ..
+
+ dokkaSourceSets.configureEach {
+ // ..
+ // source set configuration section
+ // ..
+
+ externalDocumentationLink {
+ url.set(new URL("https://kotlinlang.org/api/kotlinx.serialization/"))
+ packageListUrl.set(
+ file("serialization.package.list").toURL()
+ )
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
+
+<deflist collapsible="true">
+ <def title="url">
+ <p>The root URL of documentation to link to. It <b>must</b> contain a trailing slash.</p>
+ <p>
+ Dokka does its best to automatically find <code>package-list</code> for the given URL,
+ and link declarations together.
+ </p>
+ <p>
+ If automatic resolution fails or if you want to use locally cached files instead,
+ consider setting the <code>packageListUrl</code> option.
+ </p>
+ </def>
+ <def title="packageListUrl">
+ <p>
+ The exact location of a <code>package-list</code>. This is an alternative to relying on Dokka
+ automatically resolving it.
+ </p>
+ <p>
+ Package lists contain information about the documentation and the project itself,
+ such as module and package names.
+ </p>
+ <p>This can also be a locally cached file to avoid network calls.</p>
+ </def>
+</deflist>
+
+### Complete configuration
+
+Below you can see all possible configuration options applied at the same time.
+
+<tabs group="build-script">
+<tab title="Kotlin" group-key="kotlin">
+
+```kotlin
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.Platform
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType<DokkaTask>().configureEach {
+ moduleName.set(project.name)
+ moduleVersion.set(project.version.toString())
+ outputDirectory.set(buildDir.resolve("dokka/$name"))
+ failOnWarning.set(false)
+ suppressObviousFunctions.set(true)
+ suppressInheritedMembers.set(false)
+ offlineMode.set(false)
+
+ dokkaSourceSets {
+ named("linux") {
+ dependsOn("native")
+ sourceRoots.from(file("linux/src"))
+ }
+ configureEach {
+ suppress.set(false)
+ displayName.set(name)
+ documentedVisibilities.set(setOf(Visibility.PUBLIC))
+ reportUndocumented.set(false)
+ skipEmptyPackages.set(true)
+ skipDeprecated.set(false)
+ suppressGeneratedFiles.set(true)
+ jdkVersion.set(8)
+ languageVersion.set("1.7")
+ apiVersion.set("1.7")
+ noStdlibLink.set(false)
+ noJdkLink.set(false)
+ noAndroidSdkLink.set(false)
+ includes.from(project.files(), "packages.md", "extra.md")
+ platform.set(Platform.DEFAULT)
+ sourceRoots.from(file("src"))
+ classpath.from(project.files(), file("libs/dependency.jar"))
+ samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt")
+
+ sourceLink {
+ localDirectory.set(projectDir.resolve("src"))
+ remoteUrl.set(URL("https://github.com/kotlin/dokka/tree/master/src"))
+ remoteLineSuffix.set("#L")
+ }
+
+ externalDocumentationLink {
+ url.set(URL("https://kotlinlang.org/api/latest/jvm/stdlib/"))
+ packageListUrl.set(
+ rootProject.projectDir.resolve("stdlib.package.list").toURL()
+ )
+ }
+
+ perPackageOption {
+ matchingRegex.set(".*api.*")
+ suppress.set(false)
+ skipDeprecated.set(false)
+ reportUndocumented.set(false)
+ documentedVisibilities.set(
+ setOf(
+ Visibility.PUBLIC,
+ Visibility.PRIVATE,
+ Visibility.PROTECTED,
+ Visibility.INTERNAL,
+ Visibility.PACKAGE
+ )
+ )
+ }
+ }
+ }
+}
+```
+
+</tab>
+<tab title="Groovy" group-key="groovy">
+
+```groovy
+import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.Platform
+import java.net.URL
+
+// Note: To configure multi-project builds, you need
+// to configure Partial tasks of the subprojects.
+// See "Configuration example" section of documentation.
+tasks.withType(DokkaTask.class) {
+ moduleName.set(project.name)
+ moduleVersion.set(project.version.toString())
+ outputDirectory.set(file("build/dokka/$name"))
+ failOnWarning.set(false)
+ suppressObviousFunctions.set(true)
+ suppressInheritedMembers.set(false)
+ offlineMode.set(false)
+
+ dokkaSourceSets {
+ named("linux") {
+ dependsOn("native")
+ sourceRoots.from(file("linux/src"))
+ }
+ configureEach {
+ suppress.set(false)
+ displayName.set(name)
+ documentedVisibilities.set([Visibility.PUBLIC])
+ reportUndocumented.set(false)
+ skipEmptyPackages.set(true)
+ skipDeprecated.set(false)
+ suppressGeneratedFiles.set(true)
+ jdkVersion.set(8)
+ languageVersion.set("1.7")
+ apiVersion.set("1.7")
+ noStdlibLink.set(false)
+ noJdkLink.set(false)
+ noAndroidSdkLink.set(false)
+ includes.from(project.files(), "packages.md", "extra.md")
+ platform.set(Platform.DEFAULT)
+ sourceRoots.from(file("src"))
+ classpath.from(project.files(), file("libs/dependency.jar"))
+ samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt")
+
+ sourceLink {
+ localDirectory.set(file("src"))
+ remoteUrl.set(new URL("https://github.com/kotlin/dokka/tree/master/src"))
+ remoteLineSuffix.set("#L")
+ }
+
+ externalDocumentationLink {
+ url.set(new URL("https://kotlinlang.org/api/latest/jvm/stdlib/"))
+ packageListUrl.set(
+ file("stdlib.package.list").toURL()
+ )
+ }
+
+ perPackageOption {
+ matchingRegex.set(".*api.*")
+ suppress.set(false)
+ skipDeprecated.set(false)
+ reportUndocumented.set(false)
+ documentedVisibilities.set([Visibility.PUBLIC])
+ }
+ }
+ }
+}
+```
+
+</tab>
+</tabs>
diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md
new file mode 100644
index 00000000..9bedc517
--- /dev/null
+++ b/docs/topics/runners/dokka-maven.md
@@ -0,0 +1,646 @@
+[//]: # (title: Maven)
+
+To generate documentation for a Maven-based project, you can use the Maven plugin for Dokka.
+
+> Compared to the [Gradle plugin for Dokka](dokka-gradle.md), the Maven plugin has only basic features and
+> does not provide support for multi-module builds.
+>
+{type="note"}
+
+You can play around with Dokka and see how it can be configured for a Maven project by visiting
+our [Maven example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/maven) project.
+
+## Apply Dokka
+
+To apply Dokka, you need to add `dokka-maven-plugin` to the `plugins` section of your POM file:
+
+```xml
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ <version>%dokkaVersion%</version>
+ <executions>
+ <execution>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>dokka</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>
+```
+
+## Generate documentation
+
+The following goals are provided by the Maven plugin:
+
+### Stable
+
+| **Goal** | **Description** |
+|---------------|----------------------------------------------------------------------------------------|
+| `dokka:dokka` | Generates documentation with Dokka plugins applied. [HTML](dokka-html.md) format by default. |
+
+### Experimental
+
+| **Goal** | **Description** |
+|--------------------|---------------------------------------------------------------------------------------------|
+| `dokka:javadoc` | Generates documentation in [Javadoc](dokka-javadoc.md) format. |
+| `dokka:javadocJar` | Generates a `javadoc.jar` file that contains documentation in [Javadoc](dokka-javadoc.md) format. |
+
+### Other output formats
+
+By default, the Maven plugin for Dokka builds documentation in [HTML](dokka-html.md) output format.
+
+All other output formats are implemented as [Dokka plugins](dokka-plugins.md). In order to generate documentation in the
+desired format, you have to add it as a Dokka plugin to the configuration.
+
+For example, to use the experimental [GFM](dokka-markdown.md#gfm) format, you have to add `gfm-plugin` artifact:
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ ...
+ <configuration>
+ <dokkaPlugins>
+ <plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>gfm-plugin</artifactId>
+ <version>%dokkaVersion%</version>
+ </plugin>
+ </dokkaPlugins>
+ </configuration>
+</plugin>
+```
+
+With this configuration, running the `dokka:dokka` goal produces documentation in GFM format.
+
+To learn more about Dokka plugins, see [Dokka plugins](dokka-plugins.md).
+
+## Build javadoc.jar
+
+If you want to publish your library to a repository, you may need to provide a `javadoc.jar` file that contains
+API reference documentation of your library.
+
+For example, if you want to publish to [Maven Central](https://central.sonatype.org/), you
+[must](https://central.sonatype.org/publish/requirements/) supply a `javadoc.jar` alongside your project. However,
+not all repositories have that rule.
+
+Unlike the [Gradle plugin for Dokka](dokka-gradle.md#build-javadoc-jar), the Maven plugin comes with a ready-to-use `dokka:javadocJar`
+goal. By default, it generates documentation in [Javadoc](dokka-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 example, you want to generate
+documentation in [HTML](dokka-html.md) format instead of Javadoc), similar behavior can be achieved by adding the
+Maven JAR plugin with the following configuration:
+
+```xml
+<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>3.3.0</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>test-jar</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>dokka-jar</id>
+ <phase>package</phase>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ <configuration>
+ <classifier>dokka</classifier>
+ <classesDirectory>${project.build.directory}/dokka</classesDirectory>
+ <skipIfEmpty>true</skipIfEmpty>
+ </configuration>
+ </execution>
+ </executions>
+</plugin>
+```
+
+The documentation and the `.jar` archive for it are then generated by running `dokka:dokka` and `jar:jar@dokka-jar` goals:
+
+```Bash
+mvn dokka:dokka jar:jar@dokka-jar
+```
+
+> If you publish your library to Maven Central, you can use services like [javadoc.io](https://javadoc.io/) to
+> host your library's API documentation for free and without any setup. It takes documentation pages straight
+> from the `javadoc.jar`. It works well with the HTML format as demonstrated in
+> [this example](https://javadoc.io/doc/com.trib3/server/latest/index.html).
+>
+{type="tip"}
+
+## Configuration example
+
+Maven's plugin configuration block can be used to configure Dokka.
+
+Here is an example of a basic configuration that only changes the output location of your documentation:
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ ...
+ <configuration>
+ <outputDir>${project.basedir}/target/documentation/dokka</outputDir>
+ </configuration>
+</plugin>
+```
+
+## Configuration options
+
+Dokka has many configuration options to tailor your and your reader's experience.
+
+Below are some examples and detailed descriptions for each configuration section. You can also find an example
+with [all configuration options](#complete-configuration) applied at the bottom of the page.
+
+### General configuration
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ <!-- ... -->
+ <configuration>
+ <skip>false</skip>
+ <moduleName>${project.artifactId}</moduleName>
+ <outputDir>${project.basedir}/target/documentation</outputDir>
+ <failOnWarning>false</failOnWarning>
+ <suppressObviousFunctions>true</suppressObviousFunctions>
+ <suppressInheritedMembers>false</suppressInheritedMembers>
+ <offlineMode>false</offlineMode>
+ <sourceDirectories>
+ <dir>${project.basedir}/src</dir>
+ </sourceDirectories>
+ <documentedVisibilities>
+ <visibility>PUBLIC</visibility>
+ <visibility>PROTECTED</visibility>
+ </documentedVisibilities>
+ <reportUndocumented>false</reportUndocumented>
+ <skipDeprecated>false</skipDeprecated>
+ <skipEmptyPackages>true</skipEmptyPackages>
+ <suppressedFiles>
+ <file>/path/to/dir</file>
+ <file>/path/to/file</file>
+ </suppressedFiles>
+ <jdkVersion>8</jdkVersion>
+ <languageVersion>1.7</languageVersion>
+ <apiVersion>1.7</apiVersion>
+ <noStdlibLink>false</noStdlibLink>
+ <noJdkLink>false</noJdkLink>
+ <includes>
+ <include>packages.md</include>
+ <include>extra.md</include>
+ </includes>
+ <classpath>${project.compileClasspathElements}</classpath>
+ <samples>
+ <dir>${project.basedir}/samples</dir>
+ </samples>
+ <sourceLinks>
+ <!-- Separate section -->
+ </sourceLinks>
+ <externalDocumentationLinks>
+ <!-- Separate section -->
+ </externalDocumentationLinks>
+ <perPackageOptions>
+ <!-- Separate section -->
+ </perPackageOptions>
+ </configuration>
+</plugin>
+```
+
+<deflist collapsible="true">
+ <def title="skip">
+ <p>Whether to skip documentation generation.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="moduleName">
+ <p>The display name used to refer to the project/module. It's used for the table of contents, navigation, logging, etc.</p>
+ <p>Default: <code>{project.artifactId}</code></p>
+ </def>
+ <def title="outputDir">
+ <p>The directory to where documentation is generated, regardless of format.</p>
+ <p>Default: <code>{project.basedir}/target/dokka</code></p>
+ </def>
+ <def title="failOnWarning">
+ <p>
+ 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.
+ </p>
+ <p>This setting works well with <code>reportUndocumented</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="suppressObviousFunctions">
+ <p>Whether to suppress obvious functions.</p>
+ <p>
+ A function is considered to be obvious if it is:
+ <list>
+ <li>
+ Inherited from <code>kotlin.Any</code>, <code>Kotlin.Enum</code>, <code>java.lang.Object</code> or
+ <code>java.lang.Enum</code>, such as <code>equals</code>, <code>hashCode</code>, <code>toString</code>.
+ </li>
+ <li>
+ Synthetic (generated by the compiler) and does not have any documentation, such as
+ <code>dataClass.componentN</code> or <code>dataClass.copy</code>.
+ </li>
+ </list>
+ </p>
+ <p>Default: <code>true</code></p>
+ </def>
+ <def title="suppressInheritedMembers">
+ <p>Whether to suppress inherited members that aren't explicitly overridden in a given class.</p>
+ <p>
+ Note: This can suppress functions such as <code>equals</code>/<code>hashCode</code>/<code>toString</code>,
+ but cannot suppress synthetic functions such as <code>dataClass.componentN</code> and
+ <code>dataClass.copy</code>. Use <code>suppressObviousFunctions</code> for that.
+ </p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="offlineMode">
+ <p>Whether to resolve remote files/links over your network.</p>
+ <p>
+ This includes package-lists used for generating external documentation links.
+ For example, to make classes from the standard library clickable.
+ </p>
+ <p>
+ Setting this to <code>true</code> 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.
+ </p>
+ <p>
+ Note: You can cache fetched files locally and provide them to
+ Dokka as local paths. See <code>externalDocumentationLinks</code> section.
+ </p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="sourceDirectories">
+ <p>
+ The source code roots to be analyzed and documented.
+ Acceptable inputs are directories and individual <code>.kt</code> / <code>.java</code> files.
+ </p>
+ <p>Default: <code>{project.compileSourceRoots}</code></p>
+ </def>
+ <def title="documentedVisibilities">
+ <p>The set of visibility modifiers that should be documented.</p>
+ <p>
+ 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.
+ </p>
+ <p>Can be configured on per-package basis.</p>
+ <p>Default: <code>PUBLIC</code></p>
+ </def>
+ <def title="reportUndocumented">
+ <p>
+ Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
+ after they have been filtered by <code>documentedVisibilities</code> and other filters.
+ </p>
+ <p>This setting works well with <code>failOnWarning</code>.</p>
+ <p>This can be overridden at package level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="skipDeprecated">
+ <p>Whether to document declarations annotated with <code>@Deprecated</code>.</p>
+ <p>This can be overridden at package level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="skipEmptyPackages">
+ <p>
+ Whether to skip packages that contain no visible declarations after
+ various filters have been applied.
+ </p>
+ <p>
+ For example, if <code>skipDeprecated</code> is set to <code>true</code> and your package contains only
+ deprecated declarations, it is considered to be empty.
+ </p>
+ <p>Default: <code>true</code></p>
+ </def>
+ <def title="suppressedFiles">
+ <p>
+ The directories or individual files that should be suppressed, meaning that declarations from them
+ are not documented.
+ </p>
+ </def>
+ <def title="jdkVersion">
+ <p>The JDK version to use when generating external documentation links for Java types.</p>
+ <p>
+ For example, if you use <code>java.util.UUID</code> in some public declaration signature,
+ and this option is set to <code>8</code>, Dokka generates an external documentation link
+ to <a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html">JDK 8 Javadocs</a> for it.
+ </p>
+ <p>Default: JDK 8</p>
+ </def>
+ <def title="languageVersion">
+ <p>
+ <a href="https://kotlinlang.org/docs/compatibility-modes.html">The Kotlin language version</a>
+ used for setting up analysis and <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a>
+ environment.
+ </p>
+ <p>By default, the latest language version available to Dokka's embedded compiler is used.</p>
+ </def>
+ <def title="apiVersion">
+ <p>
+ <a href="https://kotlinlang.org/docs/compatibility-modes.html">The Kotlin API version</a>
+ used for setting up analysis and <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample</a>
+ environment.
+ </p>
+ <p>By default, it is deduced from <code>languageVersion</code>.</p>
+ </def>
+ <def title="noStdlibLink">
+ <p>
+ Whether to generate external documentation links that lead to the API reference
+ documentation of Kotlin's standard library.
+ </p>
+ <p>Note: Links <b>are</b> generated when <code>noStdLibLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="noJdkLink">
+ <p>Whether to generate external documentation links to JDK's Javadocs.</p>
+ <p>The version of JDK Javadocs is determined by the <code>jdkVersion</code> option.</p>
+ <p>Note: Links <b>are</b> generated when <code>noJdkLink</code> is set to <code>false</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="includes">
+ <p>
+ A list of Markdown files that contain
+ <a href="https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation">module and package documentation</a>
+ </p>
+ <p>The contents of specified files are parsed and embedded into documentation as module and package descriptions.</p>
+ </def>
+ <def title="classpath">
+ <p>The classpath for analysis and interactive samples.</p>
+ <p>
+ This is useful if some types that come from dependencies are not resolved/picked up automatically.
+ This option accepts both <code>.jar</code> and <code>.klib</code> files.
+ </p>
+ <p>Default: <code>{project.compileClasspathElements}</code></p>
+ </def>
+ <def title="samples">
+ <p>
+ A list of directories or files that contain sample functions which are referenced via
+ <a href="https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier">@sample KDoc tag.</a>
+ </p>
+ </def>
+</deflist>
+
+### Source link configuration
+
+The `sourceLinks` configuration block allows you to add a `source` link to each signature
+that leads to the `url` with a specific line number. (The line number is configurable by setting `lineSuffix`).
+
+This helps readers to find the source code for each declaration.
+
+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`.
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ <!-- ... -->
+ <configuration>
+ <sourceLinks>
+ <link>
+ <path>${project.basedir}/src</path>
+ <url>https://github.com/kotlin/dokka/tree/master/src</url>
+ <lineSuffix>#L</lineSuffix>
+ </link>
+ </sourceLinks>
+ </configuration>
+</plugin>
+```
+
+<deflist collapsible="true">
+ <def title="path">
+ <p>
+ The path to the local source directory. The path must be relative to the root of the
+ current module.
+ </p>
+ </def>
+ <def title="url">
+ <p>
+ 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.
+ </p>
+ </def>
+ <def title="lineSuffix">
+ <p>
+ 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.
+ </p>
+ <p>
+ The number itself is appended to the specified suffix. For example, if this option is set
+ to <code>#L</code> and the line number is 10, the resulting URL suffix is <code>#L10</code>.
+ </p>
+ <p>
+ Suffixes used by popular services:
+ <list>
+ <li>GitHub: <code>#L</code></li>
+ <li>GitLab: <code>#L</code></li>
+ <li>Bitbucket: <code>#lines-</code></li>
+ </list>
+ </p>
+ </def>
+</deflist>
+
+#### External documentation links configuration
+
+The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of
+your dependencies.
+
+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 documentation for `kotlinx.serialization`
+is 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 from the library, making
+them resolve successfully and clickable.
+
+By default, external documentation links for Kotlin standard library and JDK are configured.
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ <!-- ... -->
+ <configuration>
+ <externalDocumentationLinks>
+ <link>
+ <url>https://kotlinlang.org/api/kotlinx.serialization/</url>
+ <packageListUrl>file:/${project.basedir}/serialization.package.list</packageListUrl>
+ </link>
+ </externalDocumentationLinks>
+ </configuration>
+</plugin>
+```
+
+<deflist collapsible="true">
+ <def title="url">
+ <p>The root URL of documentation to link to. It <b>must</b> contain a trailing slash.</p>
+ <p>
+ Dokka does its best to automatically find the <code>package-list</code> for the given URL,
+ and link declarations together.
+ </p>
+ <p>
+ If automatic resolution fails or if you want to use locally cached files instead,
+ consider setting the <code>packageListUrl</code> option.
+ </p>
+ </def>
+ <def title="packageListUrl">
+ <p>
+ The exact location of a <code>package-list</code>. This is an alternative to relying on Dokka
+ automatically resolving it.
+ </p>
+ <p>
+ Package lists contain information about the documentation and the project itself,
+ such as module and package names.
+ </p>
+ <p>This can also be a locally cached file to avoid network calls.</p>
+ </def>
+</deflist>
+
+### Package options
+
+The `perPackageOptions` configuration block allows setting some options for specific packages matched by `matchingRegex`.
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ <!-- ... -->
+ <configuration>
+ <perPackageOptions>
+ <packageOptions>
+ <matchingRegex>.*api.*</matchingRegex>
+ <suppress>false</suppress>
+ <reportUndocumented>false</reportUndocumented>
+ <skipDeprecated>false</skipDeprecated>
+ <documentedVisibilities>
+ <visibility>PUBLIC</visibility>
+ <visibility>PRIVATE</visibility>
+ <visibility>PROTECTED</visibility>
+ <visibility>INTERNAL</visibility>
+ <visibility>PACKAGE</visibility>
+ </documentedVisibilities>
+ </packageOptions>
+ </perPackageOptions>
+ </configuration>
+</plugin>
+```
+
+<deflist collapsible="true">
+ <def title="matchingRegex">
+ <p>The regular expression that is used to match the package.</p>
+ <p>Default: <code>.*</code></p>
+ </def>
+ <def title="suppress">
+ <p>Whether this package should be skipped when generating documentation.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="documentedVisibilities">
+ <p>The set of visibility modifiers that should be documented.</p>
+ <p>
+ 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.
+ </p>
+ <p>Default: <code>PUBLIC</code></p>
+ </def>
+ <def title="skipDeprecated">
+ <p>Whether to document declarations annotated with <code>@Deprecated</code>.</p>
+ <p>This can be set on project/module level.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+ <def title="reportUndocumented">
+ <p>
+ Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs
+ after they have been filtered by <code>documentedVisibilities</code> and other filters.
+ </p>
+ <p>This setting works well with <code>failOnWarning</code>.</p>
+ <p>Default: <code>false</code></p>
+ </def>
+</deflist>
+
+### Complete configuration
+
+Below you can see all the possible configuration options applied at the same time.
+
+```xml
+<plugin>
+ <groupId>org.jetbrains.dokka</groupId>
+ <artifactId>dokka-maven-plugin</artifactId>
+ <!-- ... -->
+ <configuration>
+ <skip>false</skip>
+ <moduleName>${project.artifactId}</moduleName>
+ <outputDir>${project.basedir}/target/documentation</outputDir>
+ <failOnWarning>false</failOnWarning>
+ <suppressObviousFunctions>true</suppressObviousFunctions>
+ <suppressInheritedMembers>false</suppressInheritedMembers>
+ <offlineMode>false</offlineMode>
+ <sourceDirectories>
+ <dir>${project.basedir}/src</dir>
+ </sourceDirectories>
+ <documentedVisibilities>
+ <visibility>PUBLIC</visibility>
+ <visibility>PRIVATE</visibility>
+ <visibility>PROTECTED</visibility>
+ <visibility>INTERNAL</visibility>
+ <visibility>PACKAGE</visibility>
+ </documentedVisibilities>
+ <reportUndocumented>false</reportUndocumented>
+ <skipDeprecated>false</skipDeprecated>
+ <skipEmptyPackages>true</skipEmptyPackages>
+ <suppressedFiles>
+ <file>/path/to/dir</file>
+ <file>/path/to/file</file>
+ </suppressedFiles>
+ <jdkVersion>8</jdkVersion>
+ <languageVersion>1.7</languageVersion>
+ <apiVersion>1.7</apiVersion>
+ <noStdlibLink>false</noStdlibLink>
+ <noJdkLink>false</noJdkLink>
+ <includes>
+ <include>packages.md</include>
+ <include>extra.md</include>
+ </includes>
+ <classpath>${project.compileClasspathElements}</classpath>
+ <samples>
+ <dir>${project.basedir}/samples</dir>
+ </samples>
+ <sourceLinks>
+ <link>
+ <path>${project.basedir}/src</path>
+ <url>https://github.com/kotlin/dokka/tree/master/src</url>
+ <lineSuffix>#L</lineSuffix>
+ </link>
+ </sourceLinks>
+ <externalDocumentationLinks>
+ <link>
+ <url>https://kotlinlang.org/api/latest/jvm/stdlib/</url>
+ <packageListUrl>file:/${project.basedir}/stdlib.package.list</packageListUrl>
+ </link>
+ </externalDocumentationLinks>
+ <perPackageOptions>
+ <packageOptions>
+ <matchingRegex>.*api.*</matchingRegex>
+ <suppress>false</suppress>
+ <reportUndocumented>false</reportUndocumented>
+ <skipDeprecated>false</skipDeprecated>
+ <documentedVisibilities>
+ <visibility>PUBLIC</visibility>
+ <visibility>PRIVATE</visibility>
+ <visibility>PROTECTED</visibility>
+ <visibility>INTERNAL</visibility>
+ <visibility>PACKAGE</visibility>
+ </documentedVisibilities>
+ </packageOptions>
+ </perPackageOptions>
+ </configuration>
+</plugin>
+```