aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2019-09-23 10:26:51 +0200
committerKamil Doległo <kamilok1965@interia.pl>2019-10-10 12:27:20 +0200
commitc0aec1158cc72910e54a1ccb1ce4e00c330b7c06 (patch)
treef258ff58d67ce566de317f38d12aca267312e0f6 /README.md
parent34cf076ce0ede03168bb0779e3cc4d823ff0b217 (diff)
downloaddokka-c0aec1158cc72910e54a1ccb1ce4e00c330b7c06.tar.gz
dokka-c0aec1158cc72910e54a1ccb1ce4e00c330b7c06.tar.bz2
dokka-c0aec1158cc72910e54a1ccb1ce4e00c330b7c06.zip
Readme update for the androidVariant
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 43e5ac9d..ccf92094 100644
--- a/README.md
+++ b/README.md
@@ -376,8 +376,15 @@ apply plugin: 'org.jetbrains.dokka'
```
There is also a `noAndroidSdkLink` configuration parameter that works similar to `noJdkLink` and `noStdlibLink`
-By default the variant documented by dokka is the first release variant encountered. If you want to change that,
-you can disable the autoconfiguration and configure dokka manually.
+By default the variant documented by dokka is the first release variant encountered.
+You can override that by setting the `androidVariant` property inside the `configuration` (or specific platform) block:
+```groovy
+dokka {
+ configuration {
+ androidVariant = "debug"
+ }
+}
+```
### Using the Maven plugin