aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKrystianUjma <kujma@virtuslab.com>2019-06-13 13:30:55 +0200
committerKrystianUjma <kujma@virtuslab.com>2019-06-13 13:30:55 +0200
commitdd52a052d3d060adfafcf4a0237a274a241b8e33 (patch)
tree960ad1dd897bcee02b62fb6667f7312376ec6f02
parentf4280a9fcd106bdb4e886fe99cfeb1410a921ba0 (diff)
downloaddokka-dd52a052d3d060adfafcf4a0237a274a241b8e33.tar.gz
dokka-dd52a052d3d060adfafcf4a0237a274a241b8e33.tar.bz2
dokka-dd52a052d3d060adfafcf4a0237a274a241b8e33.zip
add config to readme.md - dokkaRuntime and dokkaFatJar
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 81ffe6a0..fa11fefe 100644
--- a/README.md
+++ b/README.md
@@ -275,16 +275,17 @@ repositories {
}
dependencies {
- dokkaRuntime "org.jetbrains.dokka:dokka-fatjar:0.9.18"
+ dokkaRuntime "org.jetbrains.dokka:dokka-fatjar:0.9.19"
}
dokka {
- dokkaFatJar = "dokka-fatjar-0.9.18"
+ dokkaFatJar = "dokka-fatjar-0.9.19"
outputFormat = 'html'
outputDirectory = "$buildDir/dokkaHtml"
}
```
+If you don't provide `dokkaFatJar` in `dokka` task then version from `dokka-gradle-plugin` will be used.
To use your Fat Jar, just set path to it:
@@ -300,11 +301,11 @@ To use your Fat Jar, just set path to it:
}
dependencies {
- dokkaRuntime files("/path/to/fatjar/dokka-fatjar-0.9.18.jar")
+ dokkaRuntime files("/path/to/fatjar/dokka-fatjar-0.9.19.jar")
}
dokka {
- dokkaFatJar = "dokka-fatjar-0.9.18"
+ dokkaFatJar = "dokka-fatjar-0.9.19"
outputFormat = 'html'
outputDirectory = "$buildDir/dokkaHtml"
}