diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac48e6e4ed..059028212b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,13 +29,13 @@ Here's how to import and configure Dokka in IntelliJ IDEA: If you want to use/test your locally built Dokka in a project, do the following: 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.6.20-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.6.21-my-fix-SNAPSHOT`. 2. Publish it to maven local (`./gradlew publishToMavenLocal`) 3. In the project you want to generate documentation for, add maven local as a plugin/dependency repository (`mavenLocal()`) 4. Update your dokka dependency to the version you've just published: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.6.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.6.21-my-fix-SNAPSHOT" } ``` diff --git a/README.md b/README.md index 4fa4d98624..36d70a5143 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ and can generate documentation in multiple formats including standard Javadoc, H ## Using Dokka -**Full documentation is available at [https://kotlin.github.io/dokka/1.6.20/](https://kotlin.github.io/dokka/1.6.20/)** +**Full documentation is available at [https://kotlin.github.io/dokka/1.6.21/](https://kotlin.github.io/dokka/1.6.21/)** ### Using the Gradle plugin _Note: If you are upgrading from 0.10.x to a current release of Dokka, please have a look at our @@ -18,7 +18,7 @@ The preferred way is to use `plugins` block. build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.6.20" + id("org.jetbrains.dokka") version "1.6.21" } repositories { @@ -33,7 +33,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.6.20") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } ``` @@ -42,7 +42,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.6.20") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } } ``` diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index a3d604e6a0..ea9b5cc7d9 100644 --- a/docs/src/doc/docs/community/plugins-list.md +++ b/docs/src/doc/docs/community/plugins-list.md @@ -9,10 +9,10 @@ In order to add your plugin to this list it needs to be: | Plugin name | Description | Source | | :--------- | :--------- | :------------ | -| [Kotlin as Java](https://kotlin.github.io/dokka/1.6.20/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) -| [GFM](https://kotlin.github.io/dokka/1.6.20/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm) -| [Javadoc](https://kotlin.github.io/dokka/1.6.20/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc) -| [Jekyll](https://kotlin.github.io/dokka/1.6.20/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll) +| [Kotlin as Java](https://kotlin.github.io/dokka/1.6.21/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) +| [GFM](https://kotlin.github.io/dokka/1.6.21/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm) +| [Javadoc](https://kotlin.github.io/dokka/1.6.21/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc) +| [Jekyll](https://kotlin.github.io/dokka/1.6.21/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll) | [Mermaid-HTML](https://mermaid-js.github.io/mermaid/#/) | Renders Mermaid graphs for HTML renderer. | [Github](https://github.com/glureau/dokka-mermaid) diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md index f3c816b8dc..2d49ff00e7 100644 --- a/docs/src/doc/docs/user_guide/cli/usage.md +++ b/docs/src/doc/docs/user_guide/cli/usage.md @@ -93,8 +93,8 @@ The content of JSON file ```dokkaConfiguration.json```: "sourceSetName": "main" }, "classpath": [ - "libs/kotlin-stdlib-1.6.20.jar", - "libs/kotlin-stdlib-common-1.6.20.jar" + "libs/kotlin-stdlib-1.6.21.jar", + "libs/kotlin-stdlib-common-1.6.21.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.6.20.jar", + "plugins/dokka-base-1.6.21.jar", "libs/kotlinx-html-jvm-0.7.3.jar", - "libs/dokka-analysis-1.6.20.jar", - "libs/kotlin-analysis-intellij-1.6.20.jar", - "libs/kotlin-analysis-compiler-1.6.20.jar" + "libs/dokka-analysis-1.6.21.jar", + "libs/kotlin-analysis-intellij-1.6.21.jar", + "libs/kotlin-analysis-compiler-1.6.21.jar" ], "pluginsConfiguration": [ { diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 982923fcfd..e442e265d0 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -14,7 +14,7 @@ The preferred way is to use `plugins` block. build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.6.20" + id("org.jetbrains.dokka") version "1.6.21" } 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.6.20") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } ``` @@ -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.6.20") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } } ``` @@ -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.6.20") + classpath("org.jetbrains.dokka:dokka-base:1.6.21") } } ``` diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index 59760f50f1..68a3368a49 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -1,13 +1,13 @@ import org.jetbrains.dokka.gradle.DokkaTask plugins { - kotlin("jvm") version "1.6.20" - id("org.jetbrains.dokka") version ("1.6.20") + kotlin("jvm") version "1.6.21" + id("org.jetbrains.dokka") version ("1.6.21") } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.6.20") + classpath("org.jetbrains.dokka:dokka-base:1.6.21") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 0bccbe3a6e..98ef812e85 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.6.20" - id("org.jetbrains.dokka") version ("1.6.20") + kotlin("jvm") version "1.6.21" + id("org.jetbrains.dokka") version ("1.6.21") } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index 27096f589b..6c36c01ed7 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.6.20" - id("org.jetbrains.dokka") version ("1.6.20") + kotlin("jvm") version "1.6.21" + id("org.jetbrains.dokka") version ("1.6.21") } repositories { @@ -12,11 +12,11 @@ dependencies { testImplementation(kotlin("test-junit")) // Will apply the plugin to all dokka tasks - dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.20") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.20") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.20") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index 6882eda43e..75407ab12f 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.6.20" - id("org.jetbrains.dokka") version ("1.6.20") + kotlin("jvm") version "1.6.21" + id("org.jetbrains.dokka") version ("1.6.21") `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/settings.gradle.kts b/examples/gradle/dokka-multimodule-example/settings.gradle.kts index c1afe7586c..e26c36009b 100644 --- a/examples/gradle/dokka-multimodule-example/settings.gradle.kts +++ b/examples/gradle/dokka-multimodule-example/settings.gradle.kts @@ -1,7 +1,7 @@ pluginManagement { plugins { - kotlin("jvm") version "1.6.20" - id("org.jetbrains.dokka") version ("1.6.20") + kotlin("jvm") version "1.6.21" + id("org.jetbrains.dokka") version ("1.6.21") } } diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index e3b55875e9..016c752768 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.6.20" - id("org.jetbrains.dokka") version "1.6.20" + kotlin("multiplatform") version "1.6.21" + id("org.jetbrains.dokka") version "1.6.21" } repositories { diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts index d4627ab8c6..3eeedb79b5 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.6.20" - id("org.jetbrains.dokka") version ("1.6.20") apply false + kotlin("jvm") version "1.6.21" + id("org.jetbrains.dokka") version ("1.6.21") apply false } // The versioning plugin should be applied in all submodules @@ -14,6 +14,6 @@ subprojects { } val dokkaPlugin by configurations dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.21") } } 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 2614532539..5ef330cfbe 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts @@ -9,8 +9,8 @@ val olderVersionsFolder = "olderVersions" // The previously documentations should be generated with the versioning plugin val generatePreviouslyDocTask by tasks.register("dokkaPreviouslyDocumentation") { dependencies { - dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.6.20") - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.20") + dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.6.21") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.21") } val configuredVersion = "0.9" outputDirectory.set(file(projectDir.toPath().resolve(olderVersionsFolder).resolve(configuredVersion))) diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index 8e6c4ca2b1..8e3d0c2794 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -8,8 +8,8 @@ kotlin-maven-example 1.0-SNAPSHOT - 1.6.20 - 1.6.20 + 1.6.21 + 1.6.21 diff --git a/integration-tests/gradle/projects/it-android-0/gradle.properties b/integration-tests/gradle/projects/it-android-0/gradle.properties index c932812626..dac4bb16a9 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.6.20 +dokka_it_kotlin_version=1.6.21 dokka_it_android_gradle_plugin_version=4.0.0 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 64b8ac7582..dc59f8436a 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.6.20 +dokka_it_kotlin_version=1.6.21 diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index a25f2262db..5adefda99f 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.6.20-SNAPSHOT" +version = "1.6.21-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 64b8ac7582..dc59f8436a 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.6.20 +dokka_it_kotlin_version=1.6.21 diff --git a/integration-tests/gradle/projects/it-collector-0/gradle.properties b/integration-tests/gradle/projects/it-collector-0/gradle.properties index 64b8ac7582..dc59f8436a 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.6.20 +dokka_it_kotlin_version=1.6.21 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 7c5ca4ee44..f198178031 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.6.20 -react_version=18.0.0-pre.329-kotlin-1.6.20 +dokka_it_kotlin_version=1.6.21 +react_version=18.0.0-pre.332-kotlin-1.6.21 diff --git a/integration-tests/gradle/projects/it-multimodule-0/gradle.properties b/integration-tests/gradle/projects/it-multimodule-0/gradle.properties index 64b8ac7582..dc59f8436a 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.6.20 +dokka_it_kotlin_version=1.6.21 diff --git a/integration-tests/gradle/projects/it-multimodule-1/gradle.properties b/integration-tests/gradle/projects/it-multimodule-1/gradle.properties index 64b8ac7582..dc59f8436a 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.6.20 +dokka_it_kotlin_version=1.6.21 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 1b54522314..05ce18dccb 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.6.20 +dokka_it_kotlin_version=1.6.21 diff --git a/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties b/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties index 64b8ac7582..dc59f8436a 100644 --- a/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties +++ b/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.6.20 +dokka_it_kotlin_version=1.6.21 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 9a4d1ab969..7a6781cb35 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.6.20-SNAPSHOT API """ in indexFile.readText(), + """Basic Project 1.6.21-SNAPSHOT API """ in indexFile.readText(), "Header with version number not present in index.html" ) diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/TestedVersions.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/TestedVersions.kt index 4c9d36947e..b87707a4d1 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/TestedVersions.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/TestedVersions.kt @@ -31,6 +31,6 @@ internal object TestedVersions { "1.5.0" to "-Preact_version=17.0.2-pre.204-kotlin-1.5.0", "1.6.0" to "-Preact_version=17.0.2-pre.280-kotlin-1.6.0", "1.5.31" to "-Preact_version=17.0.2-pre.265-kotlin-1.5.31", - "1.6.21" to "-Preact_version=18.0.0-pre.329-kotlin-1.6.20" // TODO update to 1.6.21 when released + "1.6.21" to "-Preact_version=18.0.0-pre.332-kotlin-1.6.21" ) } \ No newline at end of file diff --git a/integration-tests/maven/projects/it-maven/pom.xml b/integration-tests/maven/projects/it-maven/pom.xml index f8087ce477..2d7c060c06 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.6.20 + 1.6.21