diff options
37 files changed, 79 insertions, 79 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dff9cb21..cc618be4 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.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/), +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/), 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.10/developer_guide/workflow/) topic. +visit [Workflow](https://kotlin.github.io/dokka/1.8.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.8.10-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.8.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.8.10/developer_guide/workflow/ ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" } ``` @@ -42,7 +42,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.8.10" + id("org.jetbrains.dokka") version "1.8.20" } ``` @@ -64,7 +64,7 @@ Apply Gradle plugin for Dokka in the root project: ```groovy plugins { - id 'org.jetbrains.dokka' version '1.8.10' + id 'org.jetbrains.dokka' version '1.8.20' } ``` @@ -98,7 +98,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.10</version> + <version>1.8.20</version> <executions> <execution> <phase>pre-site</phase> @@ -137,7 +137,7 @@ Android platform: ```kotlin dependencies { - dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.20") } ``` @@ -148,7 +148,7 @@ dependencies { ```groovy dependencies { - dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.10' + dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.20' } ``` @@ -167,7 +167,7 @@ dependencies { <plugin> <groupId>org.jetbrains.dokka</groupId> <artifactId>android-documentation-plugin</artifactId> - <version>1.8.10</version> + <version>1.8.20</version> </plugin> </dokkaPlugins> </configuration> @@ -214,7 +214,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.10/developer_guide/introduction/). +[Developer guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/). ## Community diff --git a/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts b/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts index 9a193cbb..6c9f3caa 100644 --- a/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts +++ b/build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts @@ -9,5 +9,5 @@ plugins { tasks.dokkaHtml { onlyIf { !isLocalPublication } - outputDirectory.set(layout.buildDirectory.dir("dokka").map { it.asFile }) + outputDirectory.set(layout.buildDirectory.dir("dokka")) } diff --git a/docs/v.list b/docs/v.list index 1a6b5cea..e9005e79 100644 --- a/docs/v.list +++ b/docs/v.list @@ -4,9 +4,9 @@ <vars> <var name="dokkaVersion" - value="1.8.10" + value="1.8.20" type="string"/> <var name="kotlinVersion" - value="1.8.10" + value="1.8.20" type="string"/> </vars> diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index 594d65d3..1d6e2812 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -3,13 +3,13 @@ import org.jetbrains.dokka.base.DokkaBase import org.jetbrains.dokka.base.DokkaBaseConfiguration plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.8.10") + classpath("org.jetbrains.dokka:dokka-base:1.8.20") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 30cb4d72..ef1e4847 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.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index d1335e47..f5069636 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.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" } repositories { @@ -11,11 +11,11 @@ dependencies { testImplementation(kotlin("test-junit")) // Will apply the plugin to all Dokka tasks - dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index b01322ee..d533a976 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.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/gradle.properties b/examples/gradle/dokka-multimodule-example/gradle.properties index fa4b7d63..48c3e308 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.8.10 +kotlinVersion=1.8.20 +dokkaVersion=1.8.20 diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index ce6e4ae0..9d4283c9 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.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("multiplatform") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.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 dde5fcaa..b6f2af36 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.8.10" apply false + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" 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.8.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.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 59d0181f..cfca99ce 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.8.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") } repositories { diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index a15f6610..48eea238 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -8,8 +8,8 @@ <artifactId>kotlin-maven-example</artifactId> <version>1.0-SNAPSHOT</version> <properties> - <kotlin.version>1.8.10</kotlin.version> - <dokka.version>1.8.10</dokka.version> + <kotlin.version>1.8.20</kotlin.version> + <dokka.version>1.8.20</dokka.version> </properties> <dependencies> diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md index 9e016f68..451303cb 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.10/developer_guide/plugin-development/sample-plugin-tutorial/) +[Sample plugin](https://kotlin.github.io/dokka/1.8.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.8.10/developer_guide/plugin-development/sample-plugin-tutorial/#debugging). +[see documentation](https://kotlin.github.io/dokka/1.8.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 533bbd60..f9775de1 100644 --- a/examples/plugin/hide-internal-api/build.gradle.kts +++ b/examples/plugin/hide-internal-api/build.gradle.kts @@ -3,8 +3,8 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile import java.net.URI plugins { - kotlin("jvm") version "1.8.10" - id("org.jetbrains.dokka") version "1.8.10" + kotlin("jvm") version "1.8.20" + id("org.jetbrains.dokka") version "1.8.20" `maven-publish` signing } diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties index 8d65c730..b08cf920 100644 --- a/examples/plugin/hide-internal-api/gradle.properties +++ b/examples/plugin/hide-internal-api/gradle.properties @@ -1 +1 @@ -dokkaVersion=1.8.10 +dokkaVersion=1.8.20 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index c79dedc4..77374d87 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -2,7 +2,7 @@ gradlePlugin-kotlin = "1.8.20" gradlePlugin-android = "4.1.3" -gradlePlugin-dokka = "1.8.10" +gradlePlugin-dokka = "1.8.20" kotlinx-coroutines = "1.6.3" kotlinx-bcv = "0.12.1" diff --git a/integration-tests/gradle/projects/it-android-0/gradle.properties b/integration-tests/gradle/projects/it-android-0/gradle.properties index b139fef9..9eda8eb7 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.8.10 +dokka_it_kotlin_version=1.8.20 dokka_it_android_gradle_plugin_version=4.1.3 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 0fe2eafa..fb15e935 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.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 23f11cbb..92e868ac 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.8.10-SNAPSHOT" +version = "1.8.20-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 0fe2eafa..fb15e935 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.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-collector-0/gradle.properties b/integration-tests/gradle/projects/it-collector-0/gradle.properties index 0fe2eafa..fb15e935 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.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-configuration/build.gradle.kts b/integration-tests/gradle/projects/it-configuration/build.gradle.kts index 3b81a30a..6df50f2d 100644 --- a/integration-tests/gradle/projects/it-configuration/build.gradle.kts +++ b/integration-tests/gradle/projects/it-configuration/build.gradle.kts @@ -12,7 +12,7 @@ buildscript { } } -version = "1.8.10-SNAPSHOT" +version = "1.8.20-SNAPSHOT" apply(from = "../template.root.gradle.kts") @@ -26,4 +26,4 @@ tasks.withType<DokkaTask> { } } -fun Project.getBooleanProperty(name: String): Boolean = (project.property(name) as String).toBoolean()
\ No newline at end of file +fun Project.getBooleanProperty(name: String): Boolean = (project.property(name) as String).toBoolean() diff --git a/integration-tests/gradle/projects/it-configuration/gradle.properties b/integration-tests/gradle/projects/it-configuration/gradle.properties index 3887bf51..4606afb9 100644 --- a/integration-tests/gradle/projects/it-configuration/gradle.properties +++ b/integration-tests/gradle/projects/it-configuration/gradle.properties @@ -1,3 +1,3 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 fail_on_warning=false -report_undocumented=false
\ No newline at end of file +report_undocumented=false 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 2fe2706a..dadd2bc8 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.8.10 +dokka_it_kotlin_version=1.8.20 react_version=18.2.0-pre.467 diff --git a/integration-tests/gradle/projects/it-multimodule-0/gradle.properties b/integration-tests/gradle/projects/it-multimodule-0/gradle.properties index 0fe2eafa..fb15e935 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.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-multimodule-1/gradle.properties b/integration-tests/gradle/projects/it-multimodule-1/gradle.properties index 0fe2eafa..fb15e935 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.8.10 +dokka_it_kotlin_version=1.8.20 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 bc379f9a..da540377 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.8.10 +dokka_it_kotlin_version=1.8.20 diff --git a/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties b/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties index 9e67e4d0..aac2680b 100644 --- a/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties +++ b/integration-tests/gradle/projects/it-multiplatform-0/gradle.properties @@ -1,4 +1,4 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 #these flags are enabled by default since 1.6.20. #remove when this test is executed with Kotlin >= 1.6.20 kotlin.mpp.enableGranularSourceSetsMetadata=true diff --git a/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties b/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties index bf73b621..69f10f75 100644 --- a/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties +++ b/integration-tests/gradle/projects/it-sequential-tasks-execution-stress/gradle.properties @@ -1,2 +1,2 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 task_number=100 diff --git a/integration-tests/gradle/projects/it-wasm-basic/gradle.properties b/integration-tests/gradle/projects/it-wasm-basic/gradle.properties index 0fe2eafa..fb15e935 100644 --- a/integration-tests/gradle/projects/it-wasm-basic/gradle.properties +++ b/integration-tests/gradle/projects/it-wasm-basic/gradle.properties @@ -1 +1 @@ -dokka_it_kotlin_version=1.8.10 +dokka_it_kotlin_version=1.8.20 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 5e360816..d3598591 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.8.10-SNAPSHOT API </title>""" in indexFile.readText(), + """<title>Basic Project 1.8.20-SNAPSHOT API </title>""" in indexFile.readText(), "Header with version number not present in index.html" ) diff --git a/integration-tests/maven/projects/it-maven/pom.xml b/integration-tests/maven/projects/it-maven/pom.xml index e2db4e82..9d5ce50a 100644 --- a/integration-tests/maven/projects/it-maven/pom.xml +++ b/integration-tests/maven/projects/it-maven/pom.xml @@ -7,7 +7,7 @@ <version>1.0-SNAPSHOT</version> <properties> - <kotlin.version>1.8.10</kotlin.version> + <kotlin.version>1.8.20</kotlin.version> </properties> <build> <plugins> diff --git a/mkdocs/src/doc/docs/developer_guide/workflow.md b/mkdocs/src/doc/docs/developer_guide/workflow.md index e010d5d6..388100b2 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.8.10-my-fix-SNAPSHOT`. This version will be propagated to plugins + For instance, you can set it to something like `1.8.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.8.10-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.8.20-my-fix-SNAPSHOT" } ``` diff --git a/plugins/kotlin-as-java/README.md b/plugins/kotlin-as-java/README.md index e60c67b4..40d33e68 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.10 +org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20 ``` **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 d02ab0d4..985b975d 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.10 +org.jetbrains.dokka:mathjax-plugin:1.8.20 ``` diff --git a/plugins/versioning/README.md b/plugins/versioning/README.md index 26285267..58517bbb 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.10") + dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") } ``` @@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project. ```groovy dependencies { - dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.10' + dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.8.20' } ``` @@ -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.10</version> + <version>1.8.20</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.10) or by browsing -[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.8.10) +[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) directly, and pass it to `pluginsClasspath`. Via command line arguments: ```Bash -java -jar dokka-cli-1.8.10.jar \ - -pluginsClasspath "./dokka-base-1.8.10.jar;...;./versioning-plugin-1.8.10.jar" \ +java -jar dokka-cli-1.8.20.jar \ + -pluginsClasspath "./dokka-base-1.8.20.jar;...;./versioning-plugin-1.8.20.jar" \ ... ``` @@ -86,9 +86,9 @@ Via JSON configuration: { ... "pluginsClasspath": [ - "./dokka-base-1.8.10.jar", + "./dokka-base-1.8.20.jar", "...", - "./versioning-plugin-1.8.10.jar" + "./versioning-plugin-1.8.20.jar" ], ... } @@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration buildscript { dependencies { - classpath("org.jetbrains.dokka:versioning-plugin:1.8.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") } } @@ -232,7 +232,7 @@ dokkaHtml { <summary>CLI</summary> ```Bash -java -jar dokka-cli-1.8.10.jar \ +java -jar dokka-cli-1.8.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.8.10") + classpath("org.jetbrains.dokka:versioning-plugin:1.8.20") } } dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20") } tasks.dokkaHtml { |