Update documentation (#242)

* Update documentation on Kotlin and Java 9

* Fix requirements

* Adjust section about example projects

* List all examples

Author: fbenz

spring-auto-restdocs-docs/getting-started.adoc

@@ -6,10 +6,13 @@
 
 Spring Auto REST Docs has the following minimum requirements:
 
-* Java 7
+* Java 8 or Kotlin 1.2
 * Spring REST Docs ${spring-restdocs.version} (see http://docs.spring.io/spring-restdocs/docs/${spring-restdocs.version}/reference/html5/[documentation])
 * Jackson has to be used for creating and parsing JSON
 
+For Java 7 and Spring REST Docs 1.2.x support,
+please use the 1.0.x version of Spring Auto REST Docs.
+
 [[gettingstarted-usage]]
 === Usage
 
@@ -241,10 +244,19 @@ repositories {
 ----
 
 [[gettingstarted-sample]]
-=== Sample application
+=== Sample applications
 
-https://github.com/ScaCap/spring-auto-restdocs/tree/master/spring-auto-restdocs-example[This project]
-includes a sample application that demonstrates most features.
+This projects includes a
+https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc[Java Web MVC example],
+a
+https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webtestclient[Java WebTestClient example]
+and a
+https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc[Kotlin Web MVC example]
+application that demonstrate most features.
 
-The generated documentation of the example project can be viewed
-https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/spring-auto-restdocs-example/generated-docs/index.html[here].
+The generated documentation can be viewed for the
+https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webmvc/generated-docs/index.html[Java Web MVC example],
+the
+https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/java-webtestclient/generated-docs/index.html[Java WebTestClient example]
+and the
+https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/kotlin-webmvc/generated-docs/index.html[Kotlin Web MCV example].

spring-auto-restdocs-docs/index.adoc

@@ -58,6 +58,14 @@ Can Spring REST Docs and Spring Auto REST Docs features be combined?::
   Yes, this even works in the same test.
   One can generate Spring REST Docs snippets and Spring Auto REST Docs snippets out of the same test.
   This is demonstrated in the example project.
+Is Kotlin supported?::
+  Yes, Spring Auto REST Docs 1.0.13 and 2.0.0 introduced Kotlin support.
+  Instead of the Javadoc Doclet one has to use the Dokka extension
+  `spring-auto-restdocs-dokka-json`. The extension is only available as 2.0.x,
+  but works with both version of Spring Auto REST Docs.
+Is Java 9+ supported?::
+  Not yet, because Java 9 introduced a new Doclet API and
+  we have not created a Java 9+ Doclet yet.
 
 include::getting-started.adoc[]
 

spring-auto-restdocs-dokka-json/README.md

@@ -8,12 +8,12 @@ The same holds true for this Dokka extension.
 
 ## Usage with Maven
 
-This Dokka extension can be used with the standard `dokka-maven-plugin`.
+This Dokka extension can be used with the `dokka-maven-plugin`.
 To avoid any incompatibilities, the Dokka version of the `dokka-maven-plugin` and of this extension should be the same.
 If this extension is included as a dependency of the plugin, the output format `auto-restdocs-json` can be used.
 
 Example usage:
-```
+```xml
             <plugin>
                 <groupId>org.jetbrains.dokka</groupId>
                 <artifactId>dokka-maven-plugin</artifactId>
@@ -39,4 +39,34 @@ Example usage:
                 </configuration>
             </plugin>
 ```
+[Full example](https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/kotlin-webmvc/pom.xml)
+
+## Usage with Gradle
+
+Starting with version 2.0.2, this Dokka extension can be used with the `dokka-gradle-plugin`.
+To avoid any incompatibilities, the Dokka version of the `dokka-gradle-plugin` and of this extension should be the same.
+If this extension is set as the `dokkaFatJar` in the dokka task, the output format `auto-restdocs-json` can be used.
+
+```groovy
+buildscript {
+    ext {
+        springAutoRestDocsVersion = "2.0.2"
+        dokkaVersion = "0.9.16"
+    }
+    repositories {
+        jcenter()
+        mavenCentral()
+    }
+    dependencies {
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokkaVersion"
+    }
+}
+apply plugin: "org.jetbrains.dokka"
+
+dokka {
+    outputFormat = "auto-restdocs-json"
+    dokkaFatJar = "capital.scalable:spring-auto-restdocs-dokka-json:$springAutoRestDocsVersion"
+}
+```
+[Full example](https://github.com/ScaCap/spring-auto-restdocs/blob/master/samples/kotlin-webmvc/build.gradle)