diff options
Diffstat (limited to 'dokka-subprojects/plugin-kotlin-as-java/README.md')
| -rw-r--r-- | dokka-subprojects/plugin-kotlin-as-java/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/dokka-subprojects/plugin-kotlin-as-java/README.md b/dokka-subprojects/plugin-kotlin-as-java/README.md new file mode 100644 index 00000000..e33bd1bb --- /dev/null +++ b/dokka-subprojects/plugin-kotlin-as-java/README.md @@ -0,0 +1,15 @@ +# Kotlin as Java plugin + +With Kotlin as Java plugin applied, all Kotlin signatures will be rendered as Java signatures. + +For instance, `fun foo(bar: Bar): Baz` will be rendered as `public final Baz foo(Bar bar)`. + +The Kotlin as Java plugin is published to maven central as a +[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin): + +```text +org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10 +``` + +**This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to +[report](https://github.com/Kotlin/dokka/issues/new/choose) any errors you see. |