examples/gradle/dokka-kotlinAsJava-example/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
```