From 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Thu, 19 Jan 2023 04:10:57 +0100 Subject: Revise README documentation for examples and plugins (#2736) --- examples/gradle/dokka-kotlinAsJava-example/README.md | 19 +++++++++++++++++++ .../dokka-kotlinAsJava-example/build.gradle.kts | 2 +- examples/gradle/dokka-kotlinAsJava-example/demo.png | Bin 0 -> 101974 bytes 3 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 examples/gradle/dokka-kotlinAsJava-example/README.md create mode 100644 examples/gradle/dokka-kotlinAsJava-example/demo.png (limited to 'examples/gradle/dokka-kotlinAsJava-example') 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). + +![screenshot demonstration of output](demo.png) + +### Running + +Run `dokkaHtml` task to generate documentation for this example: + +```bash +./gradlew dokkaHtml +``` diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index 8150fdd1..d45be539 100644 --- a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts +++ b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts @@ -11,7 +11,7 @@ dependencies { implementation(kotlin("stdlib")) testImplementation(kotlin("test-junit")) - // Will apply the plugin to all dokka tasks + // Will apply the plugin to all Dokka tasks dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20") // Will apply the plugin only to the `:dokkaHtml` task diff --git a/examples/gradle/dokka-kotlinAsJava-example/demo.png b/examples/gradle/dokka-kotlinAsJava-example/demo.png new file mode 100644 index 00000000..92f1170f Binary files /dev/null and b/examples/gradle/dokka-kotlinAsJava-example/demo.png differ -- cgit