diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
| commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
| tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /plugins/javadoc/README.md | |
| parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
| download | dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2 dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip | |
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 <whyoleg@gmail.com>
Diffstat (limited to 'plugins/javadoc/README.md')
| -rw-r--r-- | plugins/javadoc/README.md | 19 |
1 files changed, 0 insertions, 19 deletions
diff --git a/plugins/javadoc/README.md b/plugins/javadoc/README.md deleted file mode 100644 index aaa1f272..00000000 --- a/plugins/javadoc/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Javadoc plugin - -The Javadoc plugin adds a Javadoc output format that looks like Java's Javadoc HTML, but it's for the most part -a lookalike, so you may experience problems if you try to use it with a tool that expects native -Javadoc documentation generated by Java. - -The Javadoc plugin is shipped with the Dokka Gradle Plugin, so you can start using it right away with one of the following -tasks: - -* `dokkaJavadoc` - builds Javadoc documentation for single-project builds or for a specific module. -* `dokkaJavadocCollector` - collects generated Javadoc documentation from submodules and assembles it together. - -The Javadoc plugin has its own signature provider that essentially translates Kotlin signatures to Java ones. - -To use it with Maven or the CLI runner, you have to add it as a dependency. You can find it on -[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/javadoc-plugin). - -**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. |