From fc574c855fb75a4fe30185aa9f12b74295b095d4 Mon Sep 17 00:00:00 2001 From: Oleg Yukhnevich Date: Mon, 16 Dec 2024 16:39:40 +0200 Subject: [PATCH] Update Kotlin/Dokka version references to 2.0.0 (#3957) --- CONTRIBUTING.md | 12 ++++----- README.md | 14 +++++----- .../docs/developer_guide/workflow.md | 4 +-- docs/topics/dokka-migration.md | 14 +++++----- docs/v.list | 4 +-- .../gradle/projects/README.md | 2 +- .../analysis-kotlin-symbols/README.md | 4 +-- .../plugin-kotlin-as-java/README.md | 2 +- dokka-subprojects/plugin-mathjax/README.md | 2 +- dokka-subprojects/plugin-versioning/README.md | 26 +++++++++---------- .../build.gradle.kts | 6 ++--- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../dokka-gradle-example/build.gradle.kts | 4 +-- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../build.gradle.kts | 10 +++---- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../build.gradle.kts | 4 +-- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../gradle.properties | 4 +-- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../build.gradle.kts | 4 +-- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../build.gradle.kts | 6 ++--- .../gradle/wrapper/gradle-wrapper.properties | 2 +- .../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 +- scripts/testDokka.sh | 2 +- scripts/testDokka.sh.md | 6 ++--- 31 files changed, 80 insertions(+), 80 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5230bb5f61..deaab19256 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,10 +23,10 @@ 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.20/developer_guide/introduction/) +Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/2.0.0/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 goes over the development [Workflow](https://kotlin.github.io/dokka/2.0.0/developer_guide/workflow/) and +[Dokka's architecture](https://kotlin.github.io/dokka/2.0.0/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 @@ -64,16 +64,16 @@ not take much time (~2-5 minutes), so please make sure they pass before submitti ### 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.20/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/2.0.0/developer_guide/workflow/) topic. -1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=1.9.20-my-fix-SNAPSHOT` +1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=2.0.0-my-fix-SNAPSHOT` 2. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency repository (`mavenLocal()`) 3. Update your Dokka dependency to the version you've just published: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "2.0.0-my-fix-SNAPSHOT" } ``` diff --git a/README.md b/README.md index 6c878d6f71..eb96b73db0 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.9.20" + id("org.jetbrains.dokka") version "2.0.0" } ``` @@ -66,7 +66,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.9.20' + id 'org.jetbrains.dokka' version '2.0.0' } ``` @@ -100,7 +100,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file: org.jetbrains.dokka dokka-maven-plugin - 1.9.20 + 2.0.0 pre-site @@ -139,7 +139,7 @@ which aims to improve documentation experience on the Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.20") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:2.0.0") } ``` @@ -150,7 +150,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.20' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:2.0.0' } ``` @@ -169,7 +169,7 @@ dependencies { org.jetbrains.dokka android-documentation-plugin - 1.9.20 + 2.0.0 @@ -216,7 +216,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.20/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/2.0.0/developer_guide/introduction/). ## Community diff --git a/docs-developer/docs/developer_guide/workflow.md b/docs-developer/docs/developer_guide/workflow.md index 584790faa4..1b62683d73 100644 --- a/docs-developer/docs/developer_guide/workflow.md +++ b/docs-developer/docs/developer_guide/workflow.md @@ -43,7 +43,7 @@ will review API changes thoroughly, so please make sure it's intentional and rat Having built Dokka locally, you can publish it to `mavenLocal()`. This will allow you to test your changes in another project as well as debug code remotely. -1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=1.9.20-my-fix-SNAPSHOT`. +1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=2.0.0-my-fix-SNAPSHOT`. This version will be propagated to plugins that reside inside Dokka's project (`mathjax`, `kotlin-as-java`, etc), and its artifacts should appear in `~/.m2` 2. In the project you want to generate documentation for or debug on, add maven local as a plugin/dependency @@ -56,7 +56,7 @@ repositories { 3. Update your Dokka dependency to the version you've just published: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "2.0.0-my-fix-SNAPSHOT" } ``` diff --git a/docs/topics/dokka-migration.md b/docs/topics/dokka-migration.md index 7e420e5bbf..52c104c02e 100644 --- a/docs/topics/dokka-migration.md +++ b/docs/topics/dokka-migration.md @@ -10,7 +10,7 @@ The Dokka Gradle plugin (DGP) is a tool for generating comprehensive API documen DGP seamlessly processes both Kotlin's KDoc comments and Java's Javadoc comments to extract information and create structured documentation in [HTML or Javadoc](#select-documentation-output-format) format. -Starting with Dokka 2.0.0-Beta, you can try the Dokka Gradle plugin v2, the new version of DGP. With Dokka 2.0.0-Beta, you can use +Starting with Dokka 2.0.0, you can try the Dokka Gradle plugin v2, the new version of DGP. With Dokka 2.0.0, you can use the Dokka Gradle plugin either in v1 or v2 modes. DGP v2 introduces significant improvements to DGP, aligning more closely with Gradle best practices: @@ -38,12 +38,12 @@ Ensure that your project meets the minimum version requirements: ### Enable the new Dokka Gradle plugin -1. Update the Dokka version to 2.0.0-Beta in the `plugins {}` block of your project’s `build.gradle.kts` file: +1. Update the Dokka version to 2.0.0 in the `plugins {}` block of your project’s `build.gradle.kts` file: ```kotlin plugins { kotlin("jvm") version "1.9.25" - id("org.jetbrains.dokka") version "2.0.0-Beta" + id("org.jetbrains.dokka") version "2.0.0" } ``` @@ -275,7 +275,7 @@ set up the convention plugin, and then apply the plugin to your modules (subproj } dependencies { - implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta") + implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0") } ``` @@ -386,10 +386,10 @@ or both formats at the same time: ```kotlin plugins { // Generates HTML documentation - id("org.jetbrains.dokka") version "2.0.0-Beta" + id("org.jetbrains.dokka") version "2.0.0" // Generates Javadoc documentation - id("org.jetbrains.dokka-javadoc") version "2.0.0-Beta" + id("org.jetbrains.dokka-javadoc") version "2.0.0" // Keeping both plugin IDs generates both formats } @@ -412,7 +412,7 @@ Here's a list of the plugin `id` and Gradle task that correspond to each format: ### Address deprecations and removals -* **Output format support:** Dokka 2.0.0-Beta only supports HTML and Javadoc output. Experimental formats like Markdown and Jekyll are no longer supported. +* **Output format support:** Dokka 2.0.0 only supports HTML and Javadoc output. Experimental formats like Markdown and Jekyll are no longer supported. * **Collector task:** `DokkaCollectorTask` has been removed. Now, you need to generate the documentation separately for each subproject and then [aggregate the documentation](#update-documentation-aggregation-in-multi-module-projects) if necessary. diff --git a/docs/v.list b/docs/v.list index 9d7232fe09..c732d231d0 100644 --- a/docs/v.list +++ b/docs/v.list @@ -4,9 +4,9 @@ diff --git a/dokka-integration-tests/gradle/projects/README.md b/dokka-integration-tests/gradle/projects/README.md index 049e198587..3c2f3c88c7 100644 --- a/dokka-integration-tests/gradle/projects/README.md +++ b/dokka-integration-tests/gradle/projects/README.md @@ -4,7 +4,7 @@ Projects used to run integration tests could be opened in or build independently 1. open `gradle.properties` file of a specific project and change commented variables: 1. `dokka_it_kotlin_version` to required version of Kotlin Gradle Plugin, e.g 2.0.0 - 2. `dokka_it_dokka_version` to required version to Dokka Gradle plugin, e.g 1.9.20 + 2. `dokka_it_dokka_version` to required version to Dokka Gradle plugin, e.g 2.0.0 3. replace all other commented properties if needed, like `dokka_it_android_gradle_plugin_version` 2. open `settings.gradle.kts` and replace `apply(from = "template.settings.gradle.kts")` with `apply(from = "../template.settings.gradle.kts")` (so the path should be prefixed with `../`) diff --git a/dokka-subprojects/analysis-kotlin-symbols/README.md b/dokka-subprojects/analysis-kotlin-symbols/README.md index a957dbb389..5cd00e2fa7 100644 --- a/dokka-subprojects/analysis-kotlin-symbols/README.md +++ b/dokka-subprojects/analysis-kotlin-symbols/README.md @@ -24,7 +24,7 @@ To build it with an override version of Analysis API, the property ### Entry point -The main entry point is `DefaultSymbolToDocumentableTranslator` (this is an extension for [the extension point](https://kotlin.github.io/dokka/1.9.20/developer_guide/architecture/extension_points/core_extensions/#sourcetodocumentabletranslator) ), that is used by the Dokka core to build Documentable model by a source set. +The main entry point is `DefaultSymbolToDocumentableTranslator` (this is an extension for [the extension point](https://kotlin.github.io/dokka/2.0.0/developer_guide/architecture/extension_points/core_extensions/#sourcetodocumentabletranslator) ), that is used by the Dokka core to build Documentable model by a source set. Across running Dokka we keep `StandaloneAnalysisAPISession` and `KtSourceModule` instances from Analysis API into `KotlinAnalysis`. `KotlinAnalysis` is used in `DefaultSymbolToDocumentableTranslator` and other services that need an additional analysis. @@ -51,4 +51,4 @@ By default, we run unit tests on TeamCity against the latest Analysis API by a s - You can use the `gradle :publishToMavenLocal` task to publish Dokka locally. - To build Dokka without running testing, using the `gradle assemble` task is recommended since the tests are time-consuming. -See the detailed guide [here](https://kotlin.github.io/dokka/1.9.20/developer_guide/workflow/). \ No newline at end of file +See the detailed guide [here](https://kotlin.github.io/dokka/2.0.0/developer_guide/workflow/). \ No newline at end of file diff --git a/dokka-subprojects/plugin-kotlin-as-java/README.md b/dokka-subprojects/plugin-kotlin-as-java/README.md index 60c0df9b85..a594bc92af 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.20 +org.jetbrains.dokka:kotlin-as-java-plugin:2.0.0 ``` **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 2eddfb9d84..c0e98a3bac 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.20 +org.jetbrains.dokka:mathjax-plugin:2.0.0 ``` diff --git a/dokka-subprojects/plugin-versioning/README.md b/dokka-subprojects/plugin-versioning/README.md index 2e59473cd3..953d84752e 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.20") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:2.0.0") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.20' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:2.0.0' } ``` @@ -55,7 +55,7 @@ plugin within subprojects as well as in their parent project. org.jetbrains.dokka versioning-plugin - 1.9.20 + 2.0.0 @@ -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.20) or by browsing -[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.20) +[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/2.0.0) or by browsing +[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/2.0.0) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.9.20.jar \ - -pluginsClasspath "./dokka-base-1.9.20.jar;...;./versioning-plugin-1.9.20.jar" \ +java -jar dokka-cli-2.0.0.jar \ + -pluginsClasspath "./dokka-base-2.0.0.jar;...;./versioning-plugin-2.0.0.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.9.20.jar", + "./dokka-base-2.0.0.jar", "...", - "./versioning-plugin-1.9.20.jar" + "./versioning-plugin-2.0.0.jar" ], ... } @@ -136,7 +136,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.9.20") + classpath("org.jetbrains.dokka:versioning-plugin:2.0.0") } } @@ -233,7 +233,7 @@ dokkaHtml { CLI ```Bash -java -jar dokka-cli-1.9.20.jar \ +java -jar dokka-cli-2.0.0.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}" @@ -294,12 +294,12 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.9.20") + classpath("org.jetbrains.dokka:versioning-plugin:2.0.0") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:2.0.0") } tasks.dokkaHtml { diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index 305545b766..d7597b15ee 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.22" - id("org.jetbrains.dokka") version "1.9.20" + kotlin("jvm") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.9.20") + classpath("org.jetbrains.dokka:dokka-base:2.0.0") } } diff --git a/examples/gradle/dokka-customFormat-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-customFormat-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-customFormat-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-customFormat-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 1220ec7856..e681a17f56 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.22" - id("org.jetbrains.dokka") version "1.9.20" + kotlin("jvm") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" } repositories { diff --git a/examples/gradle/dokka-gradle-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-gradle-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-gradle-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-gradle-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index 2f561706b2..cbd1dfafd5 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.22" - id("org.jetbrains.dokka") version "1.9.20" + kotlin("jvm") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" } 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.20") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:2.0.0") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:2.0.0") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:2.0.0") } diff --git a/examples/gradle/dokka-kotlinAsJava-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-kotlinAsJava-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-kotlinAsJava-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-kotlinAsJava-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index d6c0fb34a0..d83973ffc0 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.22" - id("org.jetbrains.dokka") version "1.9.20" + kotlin("jvm") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-library-publishing-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-library-publishing-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-library-publishing-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-library-publishing-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index be664f43e0..0fa9d5b8c0 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.22 -dokkaVersion=1.9.20 +kotlinVersion=2.1.0 +dokkaVersion=2.0.0 diff --git a/examples/gradle/dokka-multimodule-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-multimodule-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-multimodule-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-multimodule-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index 2ff70f56e9..8ca4eb0e78 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.22" - id("org.jetbrains.dokka") version "1.9.20" + kotlin("multiplatform") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" } repositories { diff --git a/examples/gradle/dokka-multiplatform-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-multiplatform-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-multiplatform-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-multiplatform-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts index 9799cd42bd..dbc206ad5f 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.22" - id("org.jetbrains.dokka") version "1.9.20" apply false + kotlin("jvm") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" 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.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:2.0.0") } } diff --git a/examples/gradle/dokka-versioning-multimodule-example/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/dokka-versioning-multimodule-example/gradle/wrapper/gradle-wrapper.properties index 1d3e1e7f3a..59e6135db1 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/gradle/wrapper/gradle-wrapper.properties +++ b/examples/gradle/dokka-versioning-multimodule-example/gradle/wrapper/gradle-wrapper.properties @@ -4,7 +4,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists 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 ae510a133b..f47a886b0f 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.20") + classpath("org.jetbrains.dokka:versioning-plugin:2.0.0") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index 42e7a2bb58..88bf4944ef 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -12,8 +12,8 @@ kotlin-maven-example 1.0-SNAPSHOT - 1.9.22 - 1.9.20 + 2.1.0 + 2.0.0 diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index 1bbf89c6b4..0cd2e2bf72 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.20/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/2.0.0/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.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/2.0.0/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 2e09936196..268d5f40b4 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.22" - id("org.jetbrains.dokka") version "1.9.20" + kotlin("jvm") version "2.1.0" + id("org.jetbrains.dokka") version "2.0.0" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index f117ce5baf..51753cd5f8 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.20 +dokkaVersion=2.0.0 diff --git a/scripts/testDokka.sh b/scripts/testDokka.sh index 9c2c4bca8e..28492add52 100755 --- a/scripts/testDokka.sh +++ b/scripts/testDokka.sh @@ -14,7 +14,7 @@ DOKKA_REPO_PATH="$SCRIPT_PATH/../" TEST_PROJECT_PATH="./examples/gradle/dokka-gradle-example" # New version to be published -NEW_VERSION="1.9.20-my-fix-SNAPSHOT" +NEW_VERSION="2.0.0-my-fix-SNAPSHOT" # Port to view results PORT=8001 diff --git a/scripts/testDokka.sh.md b/scripts/testDokka.sh.md index 715f51e940..02e0d2b2b0 100644 --- a/scripts/testDokka.sh.md +++ b/scripts/testDokka.sh.md @@ -30,7 +30,7 @@ By default it applied to the `./examples/gradle/dokka-gradle-example` project ### Specify Dokka version ```bash -./testDokka.sh -v 1.9.20-my-fix-SNAPSHOT +./testDokka.sh -v 2.0.0-my-fix-SNAPSHOT ``` ### Specify port @@ -42,7 +42,7 @@ By default it applied to the `./examples/gradle/dokka-gradle-example` project ### All together ```bash -./testDokka.sh -d ./examples/gradle/dokka-gradle-example -v 1.9.20-my-fix-SNAPSHOT -p 8001 +./testDokka.sh -d ./examples/gradle/dokka-gradle-example -v 2.0.0-my-fix-SNAPSHOT -p 8001 ``` ### Apply to a multi-module project @@ -64,4 +64,4 @@ To run the server you need to have Python 3 installed. It is not automated and should be done manually. * if occurs `Failed to write org.jetbrains.dokka.base.renderers.FileWriter@628cef4a. Parent job is Cancelling` - * then try to change the dokka version specified by `-v` parameter (e.g. `-v 1.9.20-my-fix1-SNAPSHOT`) + * then try to change the dokka version specified by `-v` parameter (e.g. `-v 2.0.0-my-fix1-SNAPSHOT`)