aboutsummaryrefslogtreecommitdiff
path: root/mkdocs
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 /mkdocs
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 'mkdocs')
-rw-r--r--mkdocs/src/doc/docs/user_guide/applying/gradle.md2
-rw-r--r--mkdocs/src/doc/docs/user_guide/applying/maven.md2
2 files changed, 2 insertions, 2 deletions
diff --git a/mkdocs/src/doc/docs/user_guide/applying/gradle.md b/mkdocs/src/doc/docs/user_guide/applying/gradle.md
index 435824f9..60ede7b9 100644
--- a/mkdocs/src/doc/docs/user_guide/applying/gradle.md
+++ b/mkdocs/src/doc/docs/user_guide/applying/gradle.md
@@ -142,7 +142,7 @@ val dokkaHtml by getting(DokkaTask::class) {
classpath.from(file("libs/dependency.jar"))
// List of files with module and package documentation
- // https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation
+ // https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html
includes.from("packages.md", "extra.md")
// List of files or directories containing sample code (referenced with @sample tags)
diff --git a/mkdocs/src/doc/docs/user_guide/applying/maven.md b/mkdocs/src/doc/docs/user_guide/applying/maven.md
index cde6e927..3ea6a56f 100644
--- a/mkdocs/src/doc/docs/user_guide/applying/maven.md
+++ b/mkdocs/src/doc/docs/user_guide/applying/maven.md
@@ -66,7 +66,7 @@ The available configuration options are shown below:
<offlineMode>false</offlineMode>
<!-- List of '.md' files with package and module docs -->
- <!-- https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation -->
+ <!-- https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html -->
<includes>
<include>packages.md</include>
<include>extra.md</include>