Merge pull request #48 from ingokegel/master

@Suppress("NOT_DOCUMENTED"), fix for linking to targets with underscores, gradle plugin improvements

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