diff options
Diffstat (limited to 'examples/gradle/dokka-kotlinAsJava-example/README.md')
| -rw-r--r-- | examples/gradle/dokka-kotlinAsJava-example/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/gradle/dokka-kotlinAsJava-example/README.md b/examples/gradle/dokka-kotlinAsJava-example/README.md new file mode 100644 index 00000000..647b0e6d --- /dev/null +++ b/examples/gradle/dokka-kotlinAsJava-example/README.md @@ -0,0 +1,19 @@ +# Dokka Kotlin-as-Java plugin example + +This example demonstrates how you can apply a Dokka plugin in a simple Gradle project. + +In particular, it applies [Kotlin as Java](../../../plugins/kotlin-as-java) Dokka plugin that renders all +Kotlin signatures as Java signatures. + +You can see up-to-date documentation generated for this example on +[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-kotlinAsJava-example/html/index.html). + + + +### Running + +Run `dokkaHtml` task to generate documentation for this example: + +```bash +./gradlew dokkaHtml +``` |