aboutsummaryrefslogtreecommitdiff
path: root/docs/topics/runners
diff options
context:
space:
mode:
authorSarah Haggarty <81160244+sarahhaggarty@users.noreply.github.com>2023-01-19 17:34:28 +0100
committerGitHub <noreply@github.com>2023-01-19 17:34:28 +0100
commit1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0 (patch)
treefad47efeadff4375d64f79eac36482d262b19287 /docs/topics/runners
parent4121336ce35ae2502ace12b5b7469fd3dbc5a4ad (diff)
downloaddokka-1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0.tar.gz
dokka-1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0.tar.bz2
dokka-1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0.zip
Add module and package documentation content (#2819)
Co-authored-by: Sarah Haggarty <sarahhaggarty@users.noreply.github.com>
Diffstat (limited to 'docs/topics/runners')
-rw-r--r--docs/topics/runners/dokka-cli.md9
-rw-r--r--docs/topics/runners/dokka-gradle.md3
-rw-r--r--docs/topics/runners/dokka-maven.md3
3 files changed, 9 insertions, 6 deletions
diff --git a/docs/topics/runners/dokka-cli.md b/docs/topics/runners/dokka-cli.md
index fa8fa459..7d76eefd 100644
--- a/docs/topics/runners/dokka-cli.md
+++ b/docs/topics/runners/dokka-cli.md
@@ -204,8 +204,8 @@ Short summary:
| `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. |
+| `samples` | List of directories or files that contain sample functions. Accepts multiple paths separated by semicolons. <anchor name="includes-cli"/> |
+| `includes` | Markdown files that contain [module and package documentation](dokka-module-and-package-docs.md). 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. |
@@ -312,6 +312,7 @@ with [all configuration options](#complete-configuration) applied at the bottom
<p>Default: <code>false</code></p>
</def>
<def title="offlineMode">
+ <anchor name="includes-json"/>
<p>Whether to resolve remote files/links over your network.</p>
<p>
This includes package-lists used for generating external documentation links.
@@ -331,7 +332,7 @@ with [all configuration options](#complete-configuration) applied at the bottom
<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>.
+ <a href="dokka-module-and-package-docs.md">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>
@@ -515,7 +516,7 @@ How to configure Kotlin
<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>.
+ <a href="dokka-module-and-package-docs.md">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>
diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md
index c049b225..f81ffe1d 100644
--- a/docs/topics/runners/dokka-gradle.md
+++ b/docs/topics/runners/dokka-gradle.md
@@ -1022,6 +1022,7 @@ tasks.withType(DokkaTask.class) {
<p>Default: <code>false</code></p>
</def>
<def title="noAndroidSdkLink">
+ <anchor name="includes"/>
<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>
@@ -1030,7 +1031,7 @@ tasks.withType(DokkaTask.class) {
<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>.
+ <a href="dokka-module-and-package-docs.md">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>
diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md
index 252abb6f..3331bce1 100644
--- a/docs/topics/runners/dokka-maven.md
+++ b/docs/topics/runners/dokka-maven.md
@@ -359,6 +359,7 @@ with [all configuration options](#complete-configuration) applied at the bottom
<p>Default: <code>false</code></p>
</def>
<def title="noJdkLink">
+ <anchor name="includes"/>
<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>
@@ -367,7 +368,7 @@ with [all configuration options](#complete-configuration) applied at the bottom
<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>
+ <a href="dokka-module-and-package-docs.md">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>