From 3cfc50dbbac369e5827c41be643298865dccf780 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Tue, 6 Jun 2023 14:51:34 +0200 Subject: [PATCH] Update Dokka's references to 1.8.20 (#3028) (cherry picked from commit bb1c1514b5c4e94fd823517d9b94b1b264c99b4c) --- CONTRIBUTING.md | 12 ++++----- README.md | 14 +++++----- .../jetbrains/conventions/dokka.gradle.kts | 2 +- docs/v.list | 4 +-- .../build.gradle.kts | 6 ++--- .../dokka-gradle-example/build.gradle.kts | 4 +-- .../build.gradle.kts | 10 +++---- .../build.gradle.kts | 4 +-- .../gradle.properties | 4 +-- .../build.gradle.kts | 4 +-- .../build.gradle.kts | 6 ++--- .../parentProject/build.gradle.kts | 2 +- examples/maven/pom.xml | 4 +-- examples/plugin/hide-internal-api/README.md | 4 +-- .../plugin/hide-internal-api/build.gradle.kts | 4 +-- .../hide-internal-api/gradle.properties | 2 +- gradle/libs.versions.toml | 2 +- .../projects/it-android-0/gradle.properties | 2 +- .../it-basic-groovy/gradle.properties | 2 +- .../gradle/projects/it-basic/build.gradle.kts | 2 +- .../projects/it-basic/gradle.properties | 2 +- .../projects/it-collector-0/gradle.properties | 2 +- .../it-configuration/build.gradle.kts | 4 +-- .../it-configuration/gradle.properties | 4 +-- .../projects/it-js-ir-0/gradle.properties | 2 +- .../it-multimodule-0/gradle.properties | 2 +- .../it-multimodule-1/gradle.properties | 2 +- .../gradle.properties | 2 +- .../it-multiplatform-0/gradle.properties | 2 +- .../gradle.properties | 2 +- .../projects/it-wasm-basic/gradle.properties | 2 +- .../it/gradle/BasicGradleIntegrationTest.kt | 2 +- .../maven/projects/it-maven/pom.xml | 2 +- .../src/doc/docs/developer_guide/workflow.md | 4 +-- plugins/kotlin-as-java/README.md | 2 +- plugins/mathjax/README.md | 2 +- plugins/versioning/README.md | 26 +++++++++---------- 37 files changed, 79 insertions(+), 79 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dff9cb2192..cc618be4c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,9 @@ Bug reports, feature requests and questions are welcome. Submit issues [here](ht ## Submitting PRs -Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.8.10/developer_guide/introduction/) documentation -which goes over the development [Workflow](https://kotlin.github.io/dokka/1.8.10/developer_guide/workflow/) and -[Dokka's architecture](https://kotlin.github.io/dokka/1.8.10/developer_guide/architecture/architecture_overview/), +Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/) documentation +which goes over the development [Workflow](https://kotlin.github.io/dokka/1.8.20/developer_guide/workflow/) and +[Dokka's architecture](https://kotlin.github.io/dokka/1.8.20/developer_guide/architecture/architecture_overview/), which can help you understand how to achieve what you want and where to look. All development (both new features and bugfixes) takes place in the `master` branch, it contains sources for the next @@ -61,10 +61,10 @@ Unit tests which are run as part of `build` should not take much time, but you c ### Use/test locally built Dokka Below you will find a bare-bones instruction on how to use and test locally built Dokka. For more details and examples, -visit [Workflow](https://kotlin.github.io/dokka/1.8.10/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.8.20/developer_guide/workflow/) topic. 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.8.10-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.8.20-my-fix-SNAPSHOT`. 2. Publish it to Maven Local (`./gradlew publishToMavenLocal`) 3. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency repository (`mavenLocal()`) @@ -72,7 +72,7 @@ visit [Workflow](https://kotlin.github.io/dokka/1.8.10/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" } ``` diff --git a/README.md b/README.md index 35ab50cc71..3a439f65b5 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.10" + id("org.jetbrains.dokka") version "1.8.20" } ``` @@ -64,7 +64,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.8.10' + id 'org.jetbrains.dokka' version '1.8.20' } ``` @@ -98,7 +98,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file: org.jetbrains.dokka dokka-maven-plugin - 1.8.10 + 1.8.20 pre-site @@ -137,7 +137,7 @@ Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.20") } ``` @@ -148,7 +148,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.10' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.20' } ``` @@ -167,7 +167,7 @@ dependencies { org.jetbrains.dokka android-documentation-plugin - 1.8.10 + 1.8.20 @@ -214,7 +214,7 @@ implement plugins for missing or very specific features that are not provided ou Learn more about Dokka plugins and their configuration in [Dokka plugins](https://kotlinlang.org/docs/dokka-plugins.html). If you want to learn how to develop Dokka plugins, see -[Developer guides](https://kotlin.github.io/dokka/1.8.10/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/). ## Community diff --git a/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts b/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts index 9a193cbb26..6c9f3caab7 100644 --- a/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts +++ b/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts @@ -9,5 +9,5 @@ plugins { tasks.dokkaHtml { onlyIf { !isLocalPublication } - outputDirectory.set(layout.buildDirectory.dir("dokka").map { it.asFile }) + outputDirectory.set(layout.buildDirectory.dir("dokka")) } diff --git a/docs/v.list b/docs/v.list index 1a6b5cea5f..e9005e79a4 100644 --- a/docs/v.list +++ b/docs/v.list @@ -4,9 +4,9 @@ diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index 594d65d39c..1d6e2812b7 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -3,13 +3,13 @@ import org.jetbrains.dokka.base.DokkaBase import org.jetbrains.dokka.base.DokkaBaseConfiguration plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.8.10") + classpath("org.jetbrains.dokka:dokka-base:1.8.20") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 30cb4d7228..ef1e4847d5 100644 --- a/examples/gradle/dokka-gradle-example/build.gradle.kts +++ b/examples/gradle/dokka-gradle-example/build.gradle.kts @@ -2,8 +2,8 @@ import org.jetbrains.dokka.gradle.DokkaTask import java.net.URL plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index d1335e4767..f5069636be 100644 --- a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts +++ b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts @@ -1,6 +1,6 @@ plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } repositories { @@ -11,11 +11,11 @@ dependencies { testImplementation(kotlin("test-junit")) // Will apply the plugin to all Dokka tasks - dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index b01322eea0..d533a97637 100644 --- a/examples/gradle/dokka-library-publishing-example/build.gradle.kts +++ b/examples/gradle/dokka-library-publishing-example/build.gradle.kts @@ -1,6 +1,6 @@ plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index fa4b7d636e..48c3e3084c 100644 --- a/examples/gradle/dokka-multimodule-example/gradle.properties +++ b/examples/gradle/dokka-multimodule-example/gradle.properties @@ -1,2 +1,2 @@ -kotlinVersion=1.8.10 -dokkaVersion=1.8.10 +kotlinVersion=1.8.20 +dokkaVersion=1.8.20 diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index ce6e4ae0b2..9d4283c9e1 100644 --- a/examples/gradle/dokka-multiplatform-example/build.gradle.kts +++ b/examples/gradle/dokka-multiplatform-example/build.gradle.kts @@ -4,8 +4,8 @@ import org.jetbrains.dokka.gradle.DokkaTask import org.jetbrains.dokka.Platform plugins { - kotlin("multiplatform") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("multiplatform") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } repositories { diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts index dde5fcaaec..b6f2af3682 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts @@ -1,6 +1,6 @@ plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" apply false + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" apply false } // The versioning plugin must be applied in all submodules @@ -14,6 +14,6 @@ subprojects { } val dokkaPlugin by configurations dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") } } diff --git a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts index 59d0181f69..cfca99ce4b 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts @@ -4,7 +4,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index a15f661099..48eea238bf 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -8,8 +8,8 @@ kotlin-maven-example 1.0-SNAPSHOT - 1.8.10 - 1.8.10 + 1.8.20 + 1.8.20 diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index 9e016f68ca..451303cb48 100644 --- a/examples/plugin/hide-internal-api/README.md +++ b/examples/plugin/hide-internal-api/README.md @@ -1,7 +1,7 @@ # Hide Internal API plugin example This project represents a simple Dokka Plugin that was developed step-by-step in the -[Sample plugin](https://kotlin.github.io/dokka/1.8.10/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/1.8.20/developer_guide/plugin-development/sample-plugin-tutorial/) tutorial. This is a frequent request with varying requirements. The plugin excludes any declaration that is marked with `org.jetbrains.dokka.internal.test.Internal` annotation. @@ -9,7 +9,7 @@ The annotation itself is not provided in this project and is instead matched by You can change it to your own internal annotation or to some other marker that suits you. To learn how to install and debug it locally, -[see documentation](https://kotlin.github.io/dokka/1.8.10/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/1.8.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). ___ diff --git a/examples/plugin/hide-internal-api/build.gradle.kts b/examples/plugin/hide-internal-api/build.gradle.kts index 533bbd6018..f9775de138 100644 --- a/examples/plugin/hide-internal-api/build.gradle.kts +++ b/examples/plugin/hide-internal-api/build.gradle.kts @@ -3,8 +3,8 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile import java.net.URI plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index 8d65c73069..b08cf9208f 100644 --- a/examples/plugin/hide-internal-api/gradle.properties +++ b/examples/plugin/hide-internal-api/gradle.properties @@ -1 +1 @@ -dokkaVersion=1.8.10 +dokkaVersion=1.8.20 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 1ef73fda6d..0afde8a1ff 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -2,7 +2,7 @@ gradlePlugin-kotlin = "1.8.20" gradlePlugin-android = "4.1.3" -gradlePlugin-dokka = "1.8.10" +gradlePlugin-dokka = "1.8.20" kotlinx-coroutines = "1.6.3" kotlinx-bcv = "0.12.1" diff --git a/integration-tests/gradle/projects/it-android-0/gradle.properties b/integration-tests/gradle/projects/it-android-0/gradle.properties index b139fef92e..9eda8eb70c 100644 --- a/integration-tests/gradle/projects/it-android-0/gradle.properties +++ b/integration-tests/gradle/projects/it-android-0/gradle.properties @@ -1,3 +1,3 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 dokka_it_android_gradle_plugin_version=4.1.3 android.useAndroidX=true diff --git a/integration-tests/gradle/projects/it-basic-groovy/gradle.properties b/integration-tests/gradle/projects/it-basic-groovy/gradle.properties index 0fe2eafaef..fb15e935d8 100644 --- a/integration-tests/gradle/projects/it-basic-groovy/gradle.properties +++ b/integration-tests/gradle/projects/it-basic-groovy/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 23f11cbbbf..92e868ac61 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -16,7 +16,7 @@ buildscript { } } -version = "1.8.10-SNAPSHOT" +version = "1.8.20-SNAPSHOT" apply(from = "../template.root.gradle.kts") diff --git a/integration-tests/gradle/projects/it-basic/gradle.properties b/integration-tests/gradle/projects/it-basic/gradle.properties index 0fe2eafaef..fb15e935d8 100644 --- a/integration-tests/gradle/projects/it-basic/gradle.properties +++ b/integration-tests/gradle/projects/it-basic/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-collector-0/gradle.properties b/integration-tests/gradle/projects/it-collector-0/gradle.properties index 0fe2eafaef..fb15e935d8 100644 --- a/integration-tests/gradle/projects/it-collector-0/gradle.properties +++ b/integration-tests/gradle/projects/it-collector-0/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-configuration/build.gradle.kts b/integration-tests/gradle/projects/it-configuration/build.gradle.kts index 3b81a30ad2..6df50f2d28 100644 --- a/integration-tests/gradle/projects/it-configuration/build.gradle.kts +++ b/integration-tests/gradle/projects/it-configuration/build.gradle.kts @@ -12,7 +12,7 @@ buildscript { } } -version = "1.8.10-SNAPSHOT" +version = "1.8.20-SNAPSHOT" apply(from = "../template.root.gradle.kts") @@ -26,4 +26,4 @@ tasks.withType { } } -fun Project.getBooleanProperty(name: String): Boolean = (project.property(name) as String).toBoolean() \ No newline at end of file +fun Project.getBooleanProperty(name: String): Boolean = (project.property(name) as String).toBoolean() diff --git a/integration-tests/gradle/projects/it-configuration/gradle.properties b/integration-tests/gradle/projects/it-configuration/gradle.properties index 3887bf515a..4606afb970 100644 --- a/integration-tests/gradle/projects/it-configuration/gradle.properties +++ b/integration-tests/gradle/projects/it-configuration/gradle.properties @@ -1,3 +1,3 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 fail_on_warning=false -report_undocumented=false \ No newline at end of file +report_undocumented=false diff --git a/integration-tests/gradle/projects/it-js-ir-0/gradle.properties b/integration-tests/gradle/projects/it-js-ir-0/gradle.properties index 2fe2706a56..dadd2bc89b 100644 --- a/integration-tests/gradle/projects/it-js-ir-0/gradle.properties +++ b/integration-tests/gradle/projects/it-js-ir-0/gradle.properties @@ -1,2 +1,2 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 react_version=18.2.0-pre.467 diff --git a/integration-tests/gradle/projects/it-multimodule-0/gradle.properties b/integration-tests/gradle/projects/it-multimodule-0/gradle.properties index 0fe2eafaef..fb15e935d8 100644 --- a/integration-tests/gradle/projects/it-multimodule-0/gradle.properties +++ b/integration-tests/gradle/projects/it-multimodule-0/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-multimodule-1/gradle.properties b/integration-tests/gradle/projects/it-multimodule-1/gradle.properties index 0fe2eafaef..fb15e935d8 100644 --- a/integration-tests/gradle/projects/it-multimodule-1/gradle.properties +++ b/integration-tests/gradle/projects/it-multimodule-1/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-multimodule-versioning-0/gradle.properties b/integration-tests/gradle/projects/it-multimodule-versioning-0/gradle.properties index bc379f9a78..da5403775f 100644 --- a/integration-tests/gradle/projects/it-multimodule-versioning-0/gradle.properties +++ b/integration-tests/gradle/projects/it-multimodule-versioning-0/gradle.properties @@ -1,2 +1,2 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties b/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties index 9e67e4d0ac..aac2680b43 100644 --- a/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties +++ b/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties @@ -1,4 +1,4 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 #these flags are enabled by default since 1.6.20. #remove when this test is executed with Kotlin >= 1.6.20 kotlin.mpp.enableGranularSourceSetsMetadata=true diff --git a/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties b/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties index bf73b62142..69f10f752a 100644 --- a/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties +++ b/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties @@ -1,2 +1,2 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 task_number=100 diff --git a/integration-tests/gradle/projects/it-wasm-basic/gradle.properties b/integration-tests/gradle/projects/it-wasm-basic/gradle.properties index 0fe2eafaef..fb15e935d8 100644 --- a/integration-tests/gradle/projects/it-wasm-basic/gradle.properties +++ b/integration-tests/gradle/projects/it-wasm-basic/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt index 5e36081602..d359859142 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt @@ -156,7 +156,7 @@ class BasicGradleIntegrationTest(override val versions: BuildVersions) : Abstrac val indexFile = File(this, "index.html") assertTrue(indexFile.isFile, "Missing index.html") assertTrue( - """Basic Project 1.8.10-SNAPSHOT API """ in indexFile.readText(), + """Basic Project 1.8.20-SNAPSHOT API """ in indexFile.readText(), "Header with version number not present in index.html" ) diff --git a/integration-tests/maven/projects/it-maven/pom.xml b/integration-tests/maven/projects/it-maven/pom.xml index e2db4e829b..9d5ce50a6e 100644 --- a/integration-tests/maven/projects/it-maven/pom.xml +++ b/integration-tests/maven/projects/it-maven/pom.xml @@ -7,7 +7,7 @@ 1.0-SNAPSHOT - 1.8.10 + 1.8.20 diff --git a/mkdocs/src/doc/docs/developer_guide/workflow.md b/mkdocs/src/doc/docs/developer_guide/workflow.md index e010d5d6c3..388100b2ad 100644 --- a/mkdocs/src/doc/docs/developer_guide/workflow.md +++ b/mkdocs/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.8.10-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.8.20-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.8.10-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" } ``` diff --git a/plugins/kotlin-as-java/README.md b/plugins/kotlin-as-java/README.md index e60c67b4f8..40d33e685e 100644 --- a/plugins/kotlin-as-java/README.md +++ b/plugins/kotlin-as-java/README.md @@ -8,7 +8,7 @@ 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.8.10 +org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20 ``` **This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to diff --git a/plugins/mathjax/README.md b/plugins/mathjax/README.md index d02ab0d416..985b975d0e 100644 --- a/plugins/mathjax/README.md +++ b/plugins/mathjax/README.md @@ -23,5 +23,5 @@ The MathJax plugin is published to Maven Central as a [separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/mathjax-plugin): ```text -org.jetbrains.dokka:mathjax-plugin:1.8.10 +org.jetbrains.dokka:mathjax-plugin:1.8.20 ``` diff --git a/plugins/versioning/README.md b/plugins/versioning/README.md index 262852674b..58517bbb56 100644 --- a/plugins/versioning/README.md +++ b/plugins/versioning/README.md @@ -19,7 +19,7 @@ You can apply the versioning plugin the same way as other Dokka plugins: ```kotlin dependencies { - dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.10' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.20' } ``` @@ -55,7 +55,7 @@ plugin within subprojects as well as in their parent project. org.jetbrains.dokka versioning-plugin - 1.8.10 + 1.8.20 @@ -68,15 +68,15 @@ plugin within subprojects as well as in their parent project. CLI You can find the versioning plugin's artifact on -[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.8.10) or by browsing -[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.8.10) +[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.8.20) or by browsing +[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.8.20) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.8.10.jar \ - -pluginsClasspath "./dokka-base-1.8.10.jar;...;./versioning-plugin-1.8.10.jar" \ +java -jar dokka-cli-1.8.20.jar \ + -pluginsClasspath "./dokka-base-1.8.20.jar;...;./versioning-plugin-1.8.20.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.8.10.jar", + "./dokka-base-1.8.20.jar", "...", - "./versioning-plugin-1.8.10.jar" + "./versioning-plugin-1.8.20.jar" ], ... } @@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") } } @@ -232,7 +232,7 @@ dokkaHtml { CLI ```Bash -java -jar dokka-cli-1.8.10.jar \ +java -jar dokka-cli-1.8.20.jar \ ... -pluginsConfiguration "org.jetbrains.dokka.versioning.VersioningPlugin={\"version\": \"1.5\", \"versionsOrdering\": [\"1.5\", \"1.4\", \"1.3\", \"1.2\", \"1.1\", \"alpha-2\", \"alpha-1\"], \"olderVersionsDir\": \"documentation/version\", \"olderVersions\": [\"documentation/alpha/alpha-2\", \"documentation/alpha/alpha-1\"], \"renderVersionsNavigationOnAllPages\": true}" @@ -290,12 +290,12 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") } tasks.dokkaHtml {