aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-04-14 15:16:12 +0200
committerGitHub <noreply@github.com>2021-04-14 15:16:12 +0200
commit357ee8a2836d96204343ff20cab8d17ad2f09aed (patch)
treea6086fad628ca0ad26ff66ddc369746c7ae9e563 /docs
parentd0f83037a12441145d35090461ef3c91df4c4076 (diff)
downloaddokka-357ee8a2836d96204343ff20cab8d17ad2f09aed.tar.gz
dokka-357ee8a2836d96204343ff20cab8d17ad2f09aed.tar.bz2
dokka-357ee8a2836d96204343ff20cab8d17ad2f09aed.zip
Improve docs for new multimodule (#1826)
Diffstat (limited to 'docs')
-rw-r--r--docs/src/doc/docs/user_guide/gradle/usage.md43
1 files changed, 28 insertions, 15 deletions
diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md
index f18d3bc8..203927d5 100644
--- a/docs/src/doc/docs/user_guide/gradle/usage.md
+++ b/docs/src/doc/docs/user_guide/gradle/usage.md
@@ -14,17 +14,16 @@ plugins {
}
repositories {
- jcenter() // or maven(url="https://dl.bintray.com/kotlin/dokka")
-}
-```
-
-settings.gradle.kts:
-```kotlin
-pluginManagement {
- repositories {
- gradlePluginPortal()
- jcenter()
+ jcenter()
+ /*
+ Or:
+ mavenCentral()
+ maven("https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven") {
+ content {
+ includeGroup("org.jetbrains.kotlinx")
+ }
}
+ */
}
```
@@ -42,7 +41,16 @@ buildscript {
}
}
repositories {
- jcenter() // or maven(url="https://dl.bintray.com/kotlin/dokka")
+ jcenter()
+ /*
+ Or:
+ mavenCentral()
+ maven("https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven") {
+ content {
+ includeGroup("org.jetbrains.kotlinx")
+ }
+ }
+ */
}
apply(plugin="org.jetbrains.dokka")
@@ -326,9 +334,14 @@ tasks.dokkaHtmlMultiModule.configure {
}
```
-`DokkaMultiModule` depends on all Dokka tasks in the subprojects, runs them, and creates a toplevel page
-with links to all generated (sub)documentations
+`DokkaMultiModule` depends on all Dokka tasks in the subprojects named `dokka${format}Partial`, runs them, and creates a toplevel page
+with links to all generated (sub)documentations. It is possible to configure each of them:
+```kotlin
+tasks.dokkaHtmlPartial.configure {
+ failOnWarning.set(true)
+}
+```
-## Example project
+## Example projects
-Please see the [Dokka Gradle example project](https://github.com/Kotlin/kotlin-examples/tree/master/gradle/dokka/dokka-gradle-example) for an example.
+Please see the [Dokka Gradle single module example project](https://github.com/Kotlin/kotlin-examples/tree/master/gradle/dokka/dokka-gradle-example) or [multimodule](https://github.com/Kotlin/kotlin-examples/tree/master/gradle/dokka/dokka-multimodule-example) for an example.