aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDmitry Jemerov <yole@jetbrains.com>2016-01-12 13:53:52 +0100
committerDmitry Jemerov <yole@jetbrains.com>2016-01-12 13:53:52 +0100
commit164575ebcdc5fda56117cdc9d5c39be3f137c88b (patch)
tree113bbf7b0f5d83d35e0f715d20e0831ae3a36637 /README.md
parentda2cf094df5e8bc0470823e7154be84dcd578cd2 (diff)
parentebdb4d43516a744bbc38f1dee2752e649c26f95d (diff)
downloaddokka-164575ebcdc5fda56117cdc9d5c39be3f137c88b.tar.gz
dokka-164575ebcdc5fda56117cdc9d5c39be3f137c88b.tar.bz2
dokka-164575ebcdc5fda56117cdc9d5c39be3f137c88b.zip
Merge remote-tracking branch 'origin/master'
# Conflicts: # dokka-gradle-plugin/src/main/kotlin/main.kt
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index ed2f8975..f955a386 100644
--- a/README.md
+++ b/README.md
@@ -132,10 +132,17 @@ buildscript {
apply plugin: 'org.jetbrains.dokka'
```
-To configure plugin use dokka lambda in the root scope. For example:
+The plugin adds a task named "dokka" to the project. The available configuration
+options are shown below:
```groovy
dokka {
+ moduleName = 'data'
+ outputFormat = 'javadoc'
+ outputDirectory = "$buildDir/javadoc"
+ processConfigurations = ['compile', 'extra']
+ includes = ['packages.md', 'extra.md']
+ samples = ['samples/basic.kt', 'samples/advanced.kt']
linkMapping {
dir = "src/main/kotlin"
url = "https://github.com/cy6erGn0m/vertx3-lang-kotlin/blob/master/src/main/kotlin"
@@ -150,6 +157,16 @@ To get it generated use gradle `dokka` task
./gradlew dokka
```
+More dokka tasks can be added to a project like this:
+
+```groovy
+task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
+ outputFormat = 'javadoc'
+ outputDirectory = "$buildDir/javadoc"
+}
+```
+
+
Please see the [Dokka Gradle example project](https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example) for an example.
## Dokka Internals