aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2019-04-16 16:52:34 +0200
committerKamil Doległo <kamilok1965@interia.pl>2019-04-16 16:53:25 +0200
commit9c28f0008928e9b31b25c787ddc5ff09fe70af03 (patch)
treed4d0b5d36e4d9231bc3e9cc8e90ffc8ed2336846
parent0d5422f375de769bbf514a72d3549ee379241c60 (diff)
downloaddokka-9c28f0008928e9b31b25c787ddc5ff09fe70af03.tar.gz
dokka-9c28f0008928e9b31b25c787ddc5ff09fe70af03.tar.bz2
dokka-9c28f0008928e9b31b25c787ddc5ff09fe70af03.zip
cherrypick readme update
-rw-r--r--README.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/README.md b/README.md
index f47f1936..bf69a393 100644
--- a/README.md
+++ b/README.md
@@ -16,17 +16,32 @@ buildscript {
repositories {
jcenter()
}
-
dependencies {
classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}"
}
}
+repositories {
+ jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' }
+}
apply plugin: 'org.jetbrains.dokka'
```
+or using the new plugins block:
+
+```groovy
+plugins {
+ id 'org.jetbrains.dokka' version '0.9.18'
+}
+repositories {
+ jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' }
+}
+```
+
The plugin adds a task named "dokka" to the project.
+If you encounter any problems when migrating from older versions of Dokka, please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq).
+
Minimal dokka configuration:
```groovy
@@ -180,7 +195,7 @@ dependencies {
```
#### FAQ
-Please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq).
+If you encounter any problems, please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq).
#### Android
@@ -192,12 +207,13 @@ buildscript {
repositories {
jcenter()
}
-
dependencies {
classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${dokka_version}"
}
}
-
+repositories {
+ jcenter()
+}
apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'org.jetbrains.dokka-android'