From 7cbdcc9ae62d03af5efbab8f5ce2d815f456513a Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Wed, 13 Jul 2022 12:13:41 +0200 Subject: Update references and documentation to Dokka 1.7.10 (#2566) --- docs/src/doc/docs/community/plugins-list.md | 2 +- docs/src/doc/docs/developer_guide/workflow.md | 4 ++-- docs/src/doc/docs/user_guide/applying/cli.md | 12 ++++++------ docs/src/doc/docs/user_guide/applying/gradle.md | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/src') diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index ed8993fc..e43dcbf3 100644 --- a/docs/src/doc/docs/community/plugins-list.md +++ b/docs/src/doc/docs/community/plugins-list.md @@ -155,6 +155,6 @@ For instance, `fun foo(bar: Bar): Baz` will be rendered as `public final Baz foo `Kotlin as Java` plugin is published to maven central as a [separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin): -`org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0`. +`org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10`. [Plugin source code on GitHub](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) diff --git a/docs/src/doc/docs/developer_guide/workflow.md b/docs/src/doc/docs/developer_guide/workflow.md index d5ebdd80..d3805cbc 100644 --- a/docs/src/doc/docs/developer_guide/workflow.md +++ b/docs/src/doc/docs/developer_guide/workflow.md @@ -42,7 +42,7 @@ Having built Dokka locally, you can publish it to `mavenLocal()`. This will allo project as well as debug code remotely. 1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version. - For instance, you can set it to something like `1.7.0-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.7.10-my-fix-SNAPSHOT`. This version will be propagated to plugins that reside inside Dokka's project (such as `mathjax`, `kotlin-as-java`, etc). 2. Publish it to maven local (`./gradlew publishToMavenLocal`). Corresponding artifacts should appear in `~/.m2` 3. In the project you want to generate documentation for or debug on, add maven local as a plugin/dependency @@ -55,7 +55,7 @@ repositories { 4. Update your dokka dependency to the version you've just published: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.0-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.7.10-my-fix-SNAPSHOT" } ``` diff --git a/docs/src/doc/docs/user_guide/applying/cli.md b/docs/src/doc/docs/user_guide/applying/cli.md index 219411b1..b0bac3fb 100644 --- a/docs/src/doc/docs/user_guide/applying/cli.md +++ b/docs/src/doc/docs/user_guide/applying/cli.md @@ -93,8 +93,8 @@ The content of JSON file ```dokkaConfiguration.json```: "sourceSetName": "main" }, "classpath": [ - "libs/kotlin-stdlib-1.7.0.jar", - "libs/kotlin-stdlib-common-1.7.0.jar" + "libs/kotlin-stdlib-1.7.10.jar", + "libs/kotlin-stdlib-common-1.7.10.jar" ], "sourceRoots": [ "/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin" @@ -135,11 +135,11 @@ The content of JSON file ```dokkaConfiguration.json```: } ], "pluginsClasspath": [ - "plugins/dokka-base-1.7.0.jar", + "plugins/dokka-base-1.7.10.jar", "libs/kotlinx-html-jvm-0.7.3.jar", - "libs/dokka-analysis-1.7.0.jar", - "libs/kotlin-analysis-intellij-1.7.0.jar", - "libs/kotlin-analysis-compiler-1.7.0.jar" + "libs/dokka-analysis-1.7.10.jar", + "libs/kotlin-analysis-intellij-1.7.10.jar", + "libs/kotlin-analysis-compiler-1.7.10.jar" ], "pluginsConfiguration": [ { diff --git a/docs/src/doc/docs/user_guide/applying/gradle.md b/docs/src/doc/docs/user_guide/applying/gradle.md index 3d0c8fa1..0ab1ff8a 100644 --- a/docs/src/doc/docs/user_guide/applying/gradle.md +++ b/docs/src/doc/docs/user_guide/applying/gradle.md @@ -14,7 +14,7 @@ The preferred way is to use `plugins` block. build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.0" + id("org.jetbrains.dokka") version "1.7.10" } repositories { @@ -269,7 +269,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of ```kotlin dependencies { - dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } ``` @@ -278,7 +278,7 @@ You can also create a custom Dokka task and add plugins directly inside: ```kotlin val customDokkaTask by creating(DokkaTask::class) { dependencies { - plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } } ``` @@ -311,7 +311,7 @@ For example, you can add `DokkaBase` to gain access to aforementioned configurat buildscript { dependencies { // classpath(":") - classpath("org.jetbrains.dokka:dokka-base:1.7.0") + classpath("org.jetbrains.dokka:dokka-base:1.7.10") } } ``` -- cgit