aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsebastian.sellmair <sebastian.sellmair@jetbrains.com>2020-07-17 15:46:02 +0200
committerSebastian Sellmair <34319766+sellmair@users.noreply.github.com>2020-07-17 15:48:53 +0200
commit6dfc9defc4bcbe20755e213d13b0a0acbee8ce3b (patch)
tree788c8f1d445aac94271bef779863381d43788ea0
parent88e1a2bb55d2162d7725c518cca5a4dfb20a304a (diff)
downloaddokka-6dfc9defc4bcbe20755e213d13b0a0acbee8ce3b.tar.gz
dokka-6dfc9defc4bcbe20755e213d13b0a0acbee8ce3b.tar.bz2
dokka-6dfc9defc4bcbe20755e213d13b0a0acbee8ce3b.zip
Remove mentions of dokka collector and add kotlin-eap to README.md
-rw-r--r--README.md27
1 files changed, 9 insertions, 18 deletions
diff --git a/README.md b/README.md
index e653505b..697962fe 100644
--- a/README.md
+++ b/README.md
@@ -87,6 +87,7 @@ eg. you'll have to use `named<DokkaTask>("dokkaHtml")` instead of `dokkaHtml`:
buildscript {
repositories {
jcenter()
+ maven("https://dl.bintray.com/kotlin/kotlin-eap")
}
dependencies {
classpath("org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}")
@@ -380,13 +381,16 @@ Make sure you apply dokka after `com.android.library` and `kotlin-android`.
buildscript {
repositories {
jcenter()
+ maven("https://dl.bintray.com/kotlin/kotlin-eap")
}
dependencies {
+ classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlin_version}")
classpath("org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}")
}
}
repositories {
jcenter()
+ maven("https://dl.bintray.com/kotlin/kotlin-eap")
}
apply(plugin= "com.android.library")
apply(plugin= "kotlin-android")
@@ -404,30 +408,13 @@ dokkaHtml {
```
#### Multi-module projects
-For documenting Gradle multi-module projects, you can use `dokka${format}Collector` and `dokka${format}Multimodule` tasks.
+For documenting Gradle multi-module projects, you can use `dokka${format}Multimodule` tasks.
```kotlin
tasks.dokkaHtmlMultimodule {
outputDirectory = "$buildDir/multimodule"
documentationFileName = "README.md"
}
-
-tasks.dokkaGfmCollector {
- outputDirectory = "$buildDir/collected"
- modules = listOf("subA", "subB") // Gradle submodule names with dokka tasks
-}
-```
-
-`DokkaCollector` creates a documentation for all submodules by taking source sets from all dokka tasks and creating a new
-dokka run with them:
-```
-For a root project and two subprojects (subA and subB) with JVM and JS source sets, dokkaCollector's source sets look like this:
-
-:dokkaHtmlCollector
-\--- :subA:jvmMain
-\--- :subA:jsMain
-\--- :subB:jvmMain
-\--- :subB:jsMain
```
`DokkaMultimodule` depends on all dokka tasks in the subprojects, runs them, and creates a toplevel page (based on the `documentationFile`)
@@ -446,6 +433,10 @@ The Maven plugin is available in JCenter. You need to add the JCenter repository
<name>JCenter</name>
<url>https://jcenter.bintray.com/</url>
</pluginRepository>
+ <pluginRepository>
+ <id>kotlin-eap</id>
+ <url>https://dl.bintray.com/kotlin/kotlin-eap/</url>
+ </pluginRepository>
</pluginRepositories>
```