diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-03-06 13:12:14 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-06 13:12:14 +0100 |
commit | ded804e5772399f1495016d598573cb20b673b58 (patch) | |
tree | 5c10a79c464c8a08764f0080d57c48476a5889ce | |
parent | dca5c3184b22b6efe0626b278f01711118fcaf0d (diff) | |
download | dokka-ded804e5772399f1495016d598573cb20b673b58.tar.gz dokka-ded804e5772399f1495016d598573cb20b673b58.tar.bz2 dokka-ded804e5772399f1495016d598573cb20b673b58.zip |
Update Dokka references to 1.8.10 (#2898)
22 files changed, 53 insertions, 53 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a19a9529..4a8dde56 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.7.20/developer_guide/introduction/) documentation -which goes over the development [Workflow](https://kotlin.github.io/dokka/1.7.20/developer_guide/workflow/) and -[Dokka's architecture](https://kotlin.github.io/dokka/1.7.20/developer_guide/architecture/architecture_overview/), +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/), 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 @@ -59,10 +59,10 @@ Unit tests which are run as part of `build` should not take much time, but you c ### Using/testing 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.7.20/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.8.10/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.7.20-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.8.10-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()`) @@ -70,7 +70,7 @@ visit [Workflow](https://kotlin.github.io/dokka/1.7.20/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT" } ``` @@ -39,7 +39,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.20" + id("org.jetbrains.dokka") version "1.8.10" } ``` @@ -61,7 +61,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.7.20' + id 'org.jetbrains.dokka' version '1.8.10' } ``` @@ -95,7 +95,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.7.20</version> + <version>1.8.10</version> <executions> <execution> <phase>pre-site</phase> @@ -134,7 +134,7 @@ Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.7.20") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.10") } ``` @@ -145,7 +145,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.7.20' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.10' } ``` @@ -164,7 +164,7 @@ dependencies { <plugin> <groupId>org.jetbrains.dokka</groupId> <artifactId>android-documentation-plugin</artifactId> - <version>1.7.20</version> + <version>1.8.10</version> </plugin> </dokkaPlugins> </configuration> @@ -211,7 +211,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.7.20/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/1.8.10/developer_guide/introduction/). ## Community diff --git a/build.gradle.kts b/build.gradle.kts index ecc30dea..1deb02f6 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -4,7 +4,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile plugins { kotlin("jvm") apply false id("java") - id("org.jetbrains.dokka") version "1.7.20" + id("org.jetbrains.dokka") version "1.8.10" id("io.github.gradle-nexus.publish-plugin") } diff --git a/docs/v.list b/docs/v.list index f16c8801..1a6b5cea 100644 --- a/docs/v.list +++ b/docs/v.list @@ -4,9 +4,9 @@ <vars> <var name="dokkaVersion" - value="1.7.20" + value="1.8.10" type="string"/> <var name="kotlinVersion" - value="1.7.20" + value="1.8.10" type="string"/> </vars> diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index f9a84bd9..3111890c 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -4,12 +4,12 @@ import org.jetbrains.dokka.base.DokkaBaseConfiguration plugins { kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version ("1.7.20") + id("org.jetbrains.dokka") version ("1.8.10") } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.7.20") + classpath("org.jetbrains.dokka:dokka-base:1.8.10") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 29d0e714..b67bea49 100644 --- a/examples/gradle/dokka-gradle-example/build.gradle.kts +++ b/examples/gradle/dokka-gradle-example/build.gradle.kts @@ -3,7 +3,7 @@ import java.net.URL plugins { kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version ("1.7.20") + id("org.jetbrains.dokka") version ("1.8.10") } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index f047d196..a6a72d36 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.7.20") + id("org.jetbrains.dokka") version ("1.8.10") } 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.7.20") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index dd49f165..98161297 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.7.20") + id("org.jetbrains.dokka") version ("1.8.10") `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index 81b732be..fa4b7d63 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.7.20 +dokkaVersion=1.8.10 diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index 7ab3bc1c..ce6e4ae0 100644 --- a/examples/gradle/dokka-multiplatform-example/build.gradle.kts +++ b/examples/gradle/dokka-multiplatform-example/build.gradle.kts @@ -5,7 +5,7 @@ import org.jetbrains.dokka.Platform plugins { kotlin("multiplatform") version "1.8.10" - id("org.jetbrains.dokka") version "1.7.20" + id("org.jetbrains.dokka") version "1.8.10" } repositories { diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts index a989c691..864828a6 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.7.20") apply false + id("org.jetbrains.dokka") version ("1.8.10") 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.7.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") } } 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 8387d9c8..295b4485 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.7.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index a5b45922..a15f6610 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -9,7 +9,7 @@ <version>1.0-SNAPSHOT</version> <properties> <kotlin.version>1.8.10</kotlin.version> - <dokka.version>1.7.20</dokka.version> + <dokka.version>1.8.10</dokka.version> </properties> <dependencies> diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index fe02e025..9e016f68 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.7.20/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/1.8.10/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.7.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/1.8.10/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 8d335b11..19b270d2 100644 --- a/examples/plugin/hide-internal-api/build.gradle.kts +++ b/examples/plugin/hide-internal-api/build.gradle.kts @@ -3,7 +3,7 @@ import java.net.URI plugins { kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.7.20" + id("org.jetbrains.dokka") version "1.8.10" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index 1dce61d6..8d65c730 100644 --- a/examples/plugin/hide-internal-api/gradle.properties +++ b/examples/plugin/hide-internal-api/gradle.properties @@ -1 +1 @@ -dokkaVersion=1.7.20 +dokkaVersion=1.8.10 diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index b1484ac9..44159de0 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.7.20-SNAPSHOT" +version = "1.8.10-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 50ab213c..5e360816 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( - """<title>Basic Project 1.7.20-SNAPSHOT API </title>""" in indexFile.readText(), + """<title>Basic Project 1.8.10-SNAPSHOT API </title>""" in indexFile.readText(), "Header with version number not present in index.html" ) diff --git a/mkdocs/src/doc/docs/developer_guide/workflow.md b/mkdocs/src/doc/docs/developer_guide/workflow.md index ddf37459..e010d5d6 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.7.20-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.8.10-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.7.20-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT" } ``` diff --git a/plugins/kotlin-as-java/README.md b/plugins/kotlin-as-java/README.md index 0098e1c7..e60c67b4 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.7.20 +org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10 ``` **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 43d07c93..d02ab0d4 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.7.20 +org.jetbrains.dokka:mathjax-plugin:1.8.10 ``` diff --git a/plugins/versioning/README.md b/plugins/versioning/README.md index 819ecf51..26285267 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.7.20") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.7.20' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.10' } ``` @@ -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.7.20</version> + <version>1.8.10</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.7.20) or by browsing -[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.7.20) +[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) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.7.20.jar \ - -pluginsClasspath "./dokka-base-1.7.20.jar;...;./versioning-plugin-1.7.20.jar" \ +java -jar dokka-cli-1.8.10.jar \ + -pluginsClasspath "./dokka-base-1.8.10.jar;...;./versioning-plugin-1.8.10.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.7.20.jar", + "./dokka-base-1.8.10.jar", "...", - "./versioning-plugin-1.7.20.jar" + "./versioning-plugin-1.8.10.jar" ], ... } @@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.7.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") } } @@ -232,7 +232,7 @@ dokkaHtml { <summary>CLI</summary> ```Bash -java -jar dokka-cli-1.7.20.jar \ +java -jar dokka-cli-1.8.10.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.7.20") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.20") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") } tasks.dokkaHtml { |