From 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Fri, 10 Nov 2023 11:46:54 +0100 Subject: Restructure the project to utilize included builds (#3174) * Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich --- dokka-subprojects/plugin-kotlin-as-java/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 dokka-subprojects/plugin-kotlin-as-java/README.md (limited to 'dokka-subprojects/plugin-kotlin-as-java/README.md') 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. -- cgit