diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a0379edcb..a75c43dd10 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.9.10/developer_guide/introduction/) documentation -which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.10/developer_guide/workflow/) and -[Dokka's architecture](https://kotlin.github.io/dokka/1.9.10/developer_guide/architecture/architecture_overview/), +Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.20/developer_guide/introduction/) documentation +which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.20/developer_guide/workflow/) and +[Dokka's architecture](https://kotlin.github.io/dokka/1.9.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.9.10/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.9.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.9.10-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.9.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.9.10/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.9.10-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT" } ``` diff --git a/README.md b/README.md index 0553b3eab2..40ec64f7e2 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.9.10" + id("org.jetbrains.dokka") version "1.9.20" } ``` @@ -65,7 +65,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.9.10' + id 'org.jetbrains.dokka' version '1.9.20' } ``` @@ -99,7 +99,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file: org.jetbrains.dokka dokka-maven-plugin - 1.9.10 + 1.9.20 pre-site @@ -138,7 +138,7 @@ Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.10") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.20") } ``` @@ -149,7 +149,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.10' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.20' } ``` @@ -168,7 +168,7 @@ dependencies { org.jetbrains.dokka android-documentation-plugin - 1.9.10 + 1.9.20 @@ -215,7 +215,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.9.10/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/1.9.20/developer_guide/introduction/). ## Community diff --git a/docs-developer/src/doc/docs/developer_guide/workflow.md b/docs-developer/src/doc/docs/developer_guide/workflow.md index 4b08d44fae..4ef55d73d2 100644 --- a/docs-developer/src/doc/docs/developer_guide/workflow.md +++ b/docs-developer/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.9.10-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.9.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.9.10-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT" } ``` diff --git a/dokka-subprojects/plugin-kotlin-as-java/README.md b/dokka-subprojects/plugin-kotlin-as-java/README.md index e33bd1bb6d..60c0df9b85 100644 --- a/dokka-subprojects/plugin-kotlin-as-java/README.md +++ b/dokka-subprojects/plugin-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.9.10 +org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20 ``` **This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to diff --git a/dokka-subprojects/plugin-mathjax/README.md b/dokka-subprojects/plugin-mathjax/README.md index a12095eeba..2eddfb9d84 100644 --- a/dokka-subprojects/plugin-mathjax/README.md +++ b/dokka-subprojects/plugin-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.9.10 +org.jetbrains.dokka:mathjax-plugin:1.9.20 ``` diff --git a/dokka-subprojects/plugin-versioning/README.md b/dokka-subprojects/plugin-versioning/README.md index d501a58fd1..66bce6dc5d 100644 --- a/dokka-subprojects/plugin-versioning/README.md +++ b/dokka-subprojects/plugin-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.9.10") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.10' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.20' } ``` @@ -55,7 +55,7 @@ plugin within subprojects as well as in their parent project. org.jetbrains.dokka versioning-plugin - 1.9.10 + 1.9.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.9.10) or by browsing -[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.10) +[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.9.20) or by browsing +[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.20) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.9.10.jar \ - -pluginsClasspath "./dokka-base-1.9.10.jar;...;./versioning-plugin-1.9.10.jar" \ +java -jar dokka-cli-1.9.20.jar \ + -pluginsClasspath "./dokka-base-1.9.20.jar;...;./versioning-plugin-1.9.20.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.9.10.jar", + "./dokka-base-1.9.20.jar", "...", - "./versioning-plugin-1.9.10.jar" + "./versioning-plugin-1.9.20.jar" ], ... } @@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.9.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.20") } } @@ -232,7 +232,7 @@ dokkaHtml { CLI ```Bash -java -jar dokka-cli-1.9.10.jar \ +java -jar dokka-cli-1.9.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.9.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.20") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20") } tasks.dokkaHtml { diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index 57f36139e8..305545b766 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -7,13 +7,13 @@ import org.jetbrains.dokka.base.DokkaBase import org.jetbrains.dokka.base.DokkaBaseConfiguration plugins { - kotlin("jvm") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" + kotlin("jvm") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.20" } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.9.10") + classpath("org.jetbrains.dokka:dokka-base:1.9.20") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 46cabe9b71..1220ec7856 100644 --- a/examples/gradle/dokka-gradle-example/build.gradle.kts +++ b/examples/gradle/dokka-gradle-example/build.gradle.kts @@ -6,8 +6,8 @@ import org.jetbrains.dokka.gradle.DokkaTask import java.net.URL plugins { - kotlin("jvm") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" + kotlin("jvm") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.20" } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index 13b43e093c..2f561706b2 100644 --- a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts +++ b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts @@ -3,8 +3,8 @@ */ plugins { - kotlin("jvm") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" + kotlin("jvm") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.20" } repositories { @@ -15,11 +15,11 @@ dependencies { testImplementation(kotlin("test-junit")) // Will apply the plugin to all Dokka tasks - dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index b21303135a..d6c0fb34a0 100644 --- a/examples/gradle/dokka-library-publishing-example/build.gradle.kts +++ b/examples/gradle/dokka-library-publishing-example/build.gradle.kts @@ -3,8 +3,8 @@ */ plugins { - kotlin("jvm") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" + kotlin("jvm") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.20" `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index 986abf13a7..be664f43e0 100644 --- a/examples/gradle/dokka-multimodule-example/gradle.properties +++ b/examples/gradle/dokka-multimodule-example/gradle.properties @@ -2,5 +2,5 @@ # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. # -kotlinVersion=1.9.10 -dokkaVersion=1.9.10 +kotlinVersion=1.9.22 +dokkaVersion=1.9.20 diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index 9416a20ace..2ff70f56e9 100644 --- a/examples/gradle/dokka-multiplatform-example/build.gradle.kts +++ b/examples/gradle/dokka-multiplatform-example/build.gradle.kts @@ -8,8 +8,8 @@ import org.jetbrains.dokka.gradle.DokkaTask import org.jetbrains.dokka.Platform plugins { - kotlin("multiplatform") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" + kotlin("multiplatform") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.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 7c15c0e900..9799cd42bd 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts @@ -3,8 +3,8 @@ */ plugins { - kotlin("jvm") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" apply false + kotlin("jvm") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.20" apply false } // The versioning plugin must be applied in all submodules @@ -18,6 +18,6 @@ subprojects { } val dokkaPlugin by configurations dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.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 51fc9453cc..ae510a133b 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts @@ -8,7 +8,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.9.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.20") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index 2bd822b061..42e7a2bb58 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -12,8 +12,8 @@ kotlin-maven-example 1.0-SNAPSHOT - 1.9.10 - 1.9.10 + 1.9.22 + 1.9.20 diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index d06e97b58b..1bbf89c6b4 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.9.10/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/1.9.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.9.10/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/1.9.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 63aa13a25e..3db275839e 100644 --- a/examples/plugin/hide-internal-api/build.gradle.kts +++ b/examples/plugin/hide-internal-api/build.gradle.kts @@ -7,8 +7,8 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile import java.net.URI plugins { - kotlin("jvm") version "1.9.10" - id("org.jetbrains.dokka") version "1.9.10" + kotlin("jvm") version "1.9.22" + id("org.jetbrains.dokka") version "1.9.20" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index 451f02af50..f117ce5baf 100644 --- a/examples/plugin/hide-internal-api/gradle.properties +++ b/examples/plugin/hide-internal-api/gradle.properties @@ -2,4 +2,4 @@ # Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. # -dokkaVersion=1.9.10 +dokkaVersion=1.9.20 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index c7ef86f28c..4031f29102 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -4,7 +4,7 @@ gradlePlugin-kotlin = "1.9.22" # See: https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin gradlePlugin-android = "4.2.2" gradlePlugin-android-dokkatoo = "8.0.2" -gradlePlugin-dokka = "1.9.10" +gradlePlugin-dokka = "1.9.20" gradlePlugin-gradle-customUserData = "1.12" gradlePlugin-gradle-enterprise = "3.14.1"