From 7e9b10797bbb262100690092ea1bf35cc7a07fb3 Mon Sep 17 00:00:00 2001 From: IgnatBeresnev Date: Tue, 17 Jan 2023 01:11:26 +0100 Subject: Shrink images and remove the "Beta formats" header in the docs --- docs/images/versioning-plugin-example.png | Bin 43684 -> 0 bytes docs/topics/formats/dokka-javadoc.md | 2 +- docs/topics/runners/dokka-gradle.md | 6 +----- 3 files changed, 2 insertions(+), 6 deletions(-) delete mode 100644 docs/images/versioning-plugin-example.png (limited to 'docs') diff --git a/docs/images/versioning-plugin-example.png b/docs/images/versioning-plugin-example.png deleted file mode 100644 index cd02c558..00000000 Binary files a/docs/images/versioning-plugin-example.png and /dev/null differ diff --git a/docs/topics/formats/dokka-javadoc.md b/docs/topics/formats/dokka-javadoc.md index 4781afcb..e9d4a6f1 100644 --- a/docs/topics/formats/dokka-javadoc.md +++ b/docs/topics/formats/dokka-javadoc.md @@ -12,7 +12,7 @@ Dokka's Javadoc output format is a lookalike of Java's It tries to visually mimic HTML pages generated by the Javadoc tool, but it's not a direct implementation or an exact copy. -![Screenshot of javadoc output format](javadoc-format-example.png){height=750} +![Screenshot of javadoc output format](javadoc-format-example.png){width=706} All Kotlin code and signatures are rendered as seen from Java's perspective. This is achieved with our [Kotlin as Java Dokka plugin](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java), which comes bundled and diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md index 81e0a2f7..c049b225 100644 --- a/docs/topics/runners/dokka-gradle.md +++ b/docs/topics/runners/dokka-gradle.md @@ -90,8 +90,6 @@ and [multi-project](#multi-project-builds) builds. Use the following tasks to build documentation for simple, single-project applications and libraries: -#### Beta formats - | **Task** | **Description** | |----------------|-------------------------------------------------------------------------------------| | `dokkaHtml` | Generates documentation in [HTML](dokka-html.md) format. | @@ -121,8 +119,6 @@ cross-project references. Dokka creates the following tasks for **parent** projects automatically: -#### Beta formats (multi-module) - | **Task** | **Description** | |--------------------------|------------------------------------------------------------------------| | `dokkaHtmlMultiModule` | Generates multi-module documentation in [HTML](dokka-html.md) output format. | @@ -194,7 +190,7 @@ parentProject These pages are generated after running `dokkaHtmlCollector`: -![Screenshot for output of dokkaHtmlCollector task](dokkaHtmlCollector-example.png){width=800} +![Screenshot for output of dokkaHtmlCollector task](dokkaHtmlCollector-example.png){width=706} See our [multi-module project example](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example) for more details. -- cgit