diff options
23 files changed, 54 insertions, 54 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc618be4..f5b60bc1 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.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/), +Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.0/developer_guide/introduction/) documentation +which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/) and +[Dokka's architecture](https://kotlin.github.io/dokka/1.9.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 @@ -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.20/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.9.0/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.20-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.9.0-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.20/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT" } ``` @@ -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.8.20" + id("org.jetbrains.dokka") version "1.9.0" } ``` @@ -65,7 +65,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.8.20' + id 'org.jetbrains.dokka' version '1.9.0' } ``` @@ -99,7 +99,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file: <plugin> <groupId>org.jetbrains.dokka</groupId> <artifactId>dokka-maven-plugin</artifactId> - <version>1.8.20</version> + <version>1.9.0</version> <executions> <execution> <phase>pre-site</phase> @@ -138,7 +138,7 @@ Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.20") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.0") } ``` @@ -149,7 +149,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.20' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.0' } ``` @@ -168,7 +168,7 @@ dependencies { <plugin> <groupId>org.jetbrains.dokka</groupId> <artifactId>android-documentation-plugin</artifactId> - <version>1.8.20</version> + <version>1.9.0</version> </plugin> </dokkaPlugins> </configuration> @@ -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.8.20/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/1.9.0/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 7db5382d..26452281 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.8.20-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.9.0-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.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT" } ``` diff --git a/docs/v.list b/docs/v.list index e9005e79..c17d5c7f 100644 --- a/docs/v.list +++ b/docs/v.list @@ -4,9 +4,9 @@ <vars> <var name="dokkaVersion" - value="1.8.20" + value="1.9.0" type="string"/> <var name="kotlinVersion" - value="1.8.20" + value="1.9.0" type="string"/> </vars> diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index ba6d1cb6..280b8edb 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -8,12 +8,12 @@ import org.jetbrains.dokka.base.DokkaBaseConfiguration plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.8.20") + classpath("org.jetbrains.dokka:dokka-base:1.9.0") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 67d3007b..0d09f96f 100644 --- a/examples/gradle/dokka-gradle-example/build.gradle.kts +++ b/examples/gradle/dokka-gradle-example/build.gradle.kts @@ -7,7 +7,7 @@ import java.net.URL plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index 62cec64d..f9711883 100644 --- a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts +++ b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts @@ -4,7 +4,7 @@ plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.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.8.20") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index d6fa25f7..003aa04f 100644 --- a/examples/gradle/dokka-library-publishing-example/build.gradle.kts +++ b/examples/gradle/dokka-library-publishing-example/build.gradle.kts @@ -4,7 +4,7 @@ plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index fac57ddd..fda31413 100644 --- a/examples/gradle/dokka-multimodule-example/gradle.properties +++ b/examples/gradle/dokka-multimodule-example/gradle.properties @@ -3,4 +3,4 @@ # kotlinVersion=1.9.0 -dokkaVersion=1.8.20 +dokkaVersion=1.9.0 diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index 33e20f3a..56c03564 100644 --- a/examples/gradle/dokka-multiplatform-example/build.gradle.kts +++ b/examples/gradle/dokka-multiplatform-example/build.gradle.kts @@ -9,7 +9,7 @@ import org.jetbrains.dokka.Platform plugins { kotlin("multiplatform") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" } repositories { diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts index 44b0b757..3984caa5 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts @@ -4,7 +4,7 @@ plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" apply false + id("org.jetbrains.dokka") version "1.9.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.8.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0") } } 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 2cca3274..4bcee160 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.8.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.0") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index 66e42847..811e4902 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -13,7 +13,7 @@ <version>1.0-SNAPSHOT</version> <properties> <kotlin.version>1.9.0</kotlin.version> - <dokka.version>1.8.20</dokka.version> + <dokka.version>1.9.0</dokka.version> </properties> <dependencies> diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index 451303cb..f186d2e0 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.20/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/1.9.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.8.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/1.9.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 2d167a17..bdbf3658 100644 --- a/examples/plugin/hide-internal-api/build.gradle.kts +++ b/examples/plugin/hide-internal-api/build.gradle.kts @@ -8,7 +8,7 @@ import java.net.URI plugins { kotlin("jvm") version "1.9.0" - id("org.jetbrains.dokka") version "1.8.20" + id("org.jetbrains.dokka") version "1.9.0" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index bee9d785..40669a38 100644 --- a/examples/plugin/hide-internal-api/gradle.properties +++ b/examples/plugin/hide-internal-api/gradle.properties @@ -2,4 +2,4 @@ # Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. # -dokkaVersion=1.8.20 +dokkaVersion=1.9.0 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 815c479e..7b650cf5 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -3,7 +3,7 @@ gradlePlugin-kotlin = "1.9.0" # See: https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin gradlePlugin-android = "4.2.2" -gradlePlugin-dokka = "1.8.20" +gradlePlugin-dokka = "1.9.0" kotlinx-coroutines = "1.6.3" kotlinx-collections-immutable = "0.3.4" diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 2528714d..4ec3b825 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -20,7 +20,7 @@ buildscript { } } -version = "1.8.20-SNAPSHOT" +version = "1.9.0-SNAPSHOT" apply(from = "../template.root.gradle.kts") diff --git a/integration-tests/gradle/projects/it-configuration/build.gradle.kts b/integration-tests/gradle/projects/it-configuration/build.gradle.kts index 3b4a7658..02e99e9b 100644 --- a/integration-tests/gradle/projects/it-configuration/build.gradle.kts +++ b/integration-tests/gradle/projects/it-configuration/build.gradle.kts @@ -16,7 +16,7 @@ buildscript { } } -version = "1.8.20-SNAPSHOT" +version = "1.9.0-SNAPSHOT" apply(from = "../template.root.gradle.kts") 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 0256f593..f214710c 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 @@ -158,7 +158,7 @@ class BasicGradleIntegrationTest : AbstractGradleIntegrationTest() { val indexFile = File(this, "index.html") assertTrue(indexFile.isFile, "Missing index.html") assertTrue( - """<title>Basic Project 1.8.20-SNAPSHOT API </title>""" in indexFile.readText(), + """<title>Basic Project 1.9.0-SNAPSHOT API </title>""" in indexFile.readText(), "Header with version number not present in index.html" ) diff --git a/plugins/kotlin-as-java/README.md b/plugins/kotlin-as-java/README.md index 40d33e68..b0ec7c8e 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.20 +org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0 ``` **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 985b975d..d9604084 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.20 +org.jetbrains.dokka:mathjax-plugin:1.9.0 ``` diff --git a/plugins/versioning/README.md b/plugins/versioning/README.md index 58517bbb..be36ef0e 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.20") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.20' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.0' } ``` @@ -55,7 +55,7 @@ plugin within subprojects as well as in their parent project. <plugin> <groupId>org.jetbrains.dokka</groupId> <artifactId>versioning-plugin</artifactId> - <version>1.8.20</version> + <version>1.9.0</version> </plugin> </dokkaPlugins> </configuration> @@ -68,15 +68,15 @@ plugin within subprojects as well as in their parent project. <summary>CLI</summary> You can find the versioning plugin's artifact on -[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) +[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.9.0) or by browsing +[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.0) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.8.20.jar \ - -pluginsClasspath "./dokka-base-1.8.20.jar;...;./versioning-plugin-1.8.20.jar" \ +java -jar dokka-cli-1.9.0.jar \ + -pluginsClasspath "./dokka-base-1.9.0.jar;...;./versioning-plugin-1.9.0.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.8.20.jar", + "./dokka-base-1.9.0.jar", "...", - "./versioning-plugin-1.8.20.jar" + "./versioning-plugin-1.9.0.jar" ], ... } @@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.0") } } @@ -232,7 +232,7 @@ dokkaHtml { <summary>CLI</summary> ```Bash -java -jar dokka-cli-1.8.20.jar \ +java -jar dokka-cli-1.9.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}" @@ -290,12 +290,12 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.9.0") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0") } tasks.dokkaHtml { |