diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0459c850cc..55c6c0200b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,13 +29,13 @@ Here's how to import and configure Dokka in IntelliJ IDEA: If you want to use/test your locally built Dokka in a project, do the following: 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.0-my-fix-SNAPSHOT`. + For instance, you can set it to something like `1.7.10-my-fix-SNAPSHOT`. 2. Publish it to maven local (`./gradlew publishToMavenLocal`) 3. In the project you want to generate documentation for, add maven local as a plugin/dependency repository (`mavenLocal()`) 4. Update your dokka dependency to the version you've just published: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.0-my-fix-SNAPSHOT" + id("org.jetbrains.dokka") version "1.7.10-my-fix-SNAPSHOT" } ``` diff --git a/README.md b/README.md index 09c60a6af5..45818ffba6 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ and can generate documentation in multiple formats including standard Javadoc, H ## Using Dokka -**Full documentation is available at [https://kotlin.github.io/dokka/1.7.0/](https://kotlin.github.io/dokka/1.7.0/)** +**Full documentation is available at [https://kotlin.github.io/dokka/1.7.10/](https://kotlin.github.io/dokka/1.7.10/)** ### Using the Gradle plugin _Note: If you are upgrading from 0.10.x to a current release of Dokka, please have a look at our @@ -22,7 +22,7 @@ The preferred way is to use `plugins` block. build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.0" + id("org.jetbrains.dokka") version "1.7.10" } repositories { @@ -37,7 +37,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of ```kotlin dependencies { - dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } ``` @@ -46,7 +46,7 @@ You can also create a custom Dokka task and add plugins directly inside: ```kotlin val customDokkaTask by creating(DokkaTask::class) { dependencies { - plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } } ``` diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index 4a65965ed7..26d7a9d928 100644 --- a/docs/src/doc/docs/community/plugins-list.md +++ b/docs/src/doc/docs/community/plugins-list.md @@ -9,10 +9,10 @@ In order to add your plugin to this list it needs to be: | Plugin name | Description | Source | | :--------- | :--------- | :------------ | -| [Kotlin as Java](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) -| [GFM](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm) -| [Javadoc](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc) -| [Jekyll](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll) +| [Kotlin as Java](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) +| [GFM](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm) +| [Javadoc](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc) +| [Jekyll](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll) | [Mermaid-HTML](https://mermaid-js.github.io/mermaid/#/) | Renders Mermaid graphs for HTML renderer. | [Github](https://github.com/glureau/dokka-mermaid) diff --git a/docs/src/doc/docs/user_guide/base-specific/frontend.md b/docs/src/doc/docs/user_guide/base-specific/frontend.md index f1de420d2d..91d83aba5d 100644 --- a/docs/src/doc/docs/user_guide/base-specific/frontend.md +++ b/docs/src/doc/docs/user_guide/base-specific/frontend.md @@ -99,7 +99,7 @@ Variables given below are available to the template: Also, Dokka-defined [directives](https://freemarker.apache.org/docs/ref_directive_userDefined.html) can be used: * `<@content/>` - main content * `<@resources/>` - scripts, stylesheets -* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.0/user_guide/versioning/versioning/) will replace this with a version navigator) +* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.10/user_guide/versioning/versioning/) will replace this with a version navigator) * `<@template_cmd name="...""> ...` - is used for variables that depend on the root project (such `pathToRoot`, `projectName`). They are available only inside the directive. This is processed by a multi-module task that assembles partial outputs from modules. Example: ``` diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md index a489979dd8..f109710ca1 100644 --- a/docs/src/doc/docs/user_guide/cli/usage.md +++ b/docs/src/doc/docs/user_guide/cli/usage.md @@ -93,8 +93,8 @@ The content of JSON file ```dokkaConfiguration.json```: "sourceSetName": "main" }, "classpath": [ - "libs/kotlin-stdlib-1.7.0.jar", - "libs/kotlin-stdlib-common-1.7.0.jar" + "libs/kotlin-stdlib-1.7.10.jar", + "libs/kotlin-stdlib-common-1.7.10.jar" ], "sourceRoots": [ "/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin" @@ -135,11 +135,11 @@ The content of JSON file ```dokkaConfiguration.json```: } ], "pluginsClasspath": [ - "plugins/dokka-base-1.7.0.jar", + "plugins/dokka-base-1.7.10.jar", "libs/kotlinx-html-jvm-0.7.3.jar", - "libs/dokka-analysis-1.7.0.jar", - "libs/kotlin-analysis-intellij-1.7.0.jar", - "libs/kotlin-analysis-compiler-1.7.0.jar" + "libs/dokka-analysis-1.7.10.jar", + "libs/kotlin-analysis-intellij-1.7.10.jar", + "libs/kotlin-analysis-compiler-1.7.10.jar" ], "pluginsConfiguration": [ { diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 399075a5cc..d367e5e6b2 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -14,7 +14,7 @@ The preferred way is to use `plugins` block. build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.7.0" + id("org.jetbrains.dokka") version "1.7.10" } repositories { @@ -269,7 +269,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of ```kotlin dependencies { - dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } ``` @@ -278,7 +278,7 @@ You can also create a custom Dokka task and add plugins directly inside: ```kotlin val customDokkaTask by creating(DokkaTask::class) { dependencies { - plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } } ``` @@ -311,7 +311,7 @@ For example, you can add `DokkaBase` to gain access to aforementioned configurat buildscript { dependencies { // classpath(":") - classpath("org.jetbrains.dokka:dokka-base:1.7.0") + classpath("org.jetbrains.dokka:dokka-base:1.7.10") } } ``` diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index 987ac9ec90..965593b10d 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -2,12 +2,12 @@ import org.jetbrains.dokka.gradle.DokkaTask plugins { kotlin("jvm") version "1.7.10" - id("org.jetbrains.dokka") version ("1.7.0") + id("org.jetbrains.dokka") version ("1.7.10") } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.7.0") + classpath("org.jetbrains.dokka:dokka-base:1.7.10") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 72eb8637fa..bf1b31c1dd 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.7.10" - id("org.jetbrains.dokka") version ("1.7.0") + id("org.jetbrains.dokka") version ("1.7.10") } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index a808fd7e09..5e5b33f606 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.7.10" - id("org.jetbrains.dokka") version ("1.7.0") + id("org.jetbrains.dokka") version ("1.7.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.0") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index 0aaa280ec5..1580a7e097 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.7.10" - id("org.jetbrains.dokka") version ("1.7.0") + id("org.jetbrains.dokka") version ("1.7.10") `java-library` `maven-publish` } diff --git a/examples/gradle/dokka-multimodule-example/settings.gradle.kts b/examples/gradle/dokka-multimodule-example/settings.gradle.kts index 4226ba8992..cc019c78f4 100644 --- a/examples/gradle/dokka-multimodule-example/settings.gradle.kts +++ b/examples/gradle/dokka-multimodule-example/settings.gradle.kts @@ -1,7 +1,7 @@ pluginManagement { plugins { kotlin("jvm") version "1.7.10" - id("org.jetbrains.dokka") version ("1.7.0") + id("org.jetbrains.dokka") version ("1.7.10") } } diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index 32f75d9f6b..19d86ac737 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.7.10" - id("org.jetbrains.dokka") version "1.7.0" + id("org.jetbrains.dokka") version "1.7.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 55b2eee551..8d6eb8f4ca 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.7.10" - id("org.jetbrains.dokka") version ("1.7.0") apply false + id("org.jetbrains.dokka") version ("1.7.10") apply false } // The versioning plugin should be applied in all submodules @@ -14,6 +14,6 @@ subprojects { } val dokkaPlugin by configurations dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.0") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.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 83f7f47478..9bc8c99109 100644 --- a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts +++ b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts @@ -9,8 +9,8 @@ val olderVersionsFolder = "olderVersions" // The previously documentations should be generated with the versioning plugin val generatePreviouslyDocTask by tasks.register("dokkaPreviouslyDocumentation") { dependencies { - dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.7.0") - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.0") + dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.7.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.10") } val configuredVersion = "0.9" outputDirectory.set(file(projectDir.toPath().resolve(olderVersionsFolder).resolve(configuredVersion))) diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index dabb01f794..d6b5bb33a5 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -9,7 +9,7 @@ 1.0-SNAPSHOT 1.7.10 - 1.7.0 + 1.7.10 diff --git a/gradle.properties b/gradle.properties index 8572a63c42..929a3819b6 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ # Project Settings -dokka_version=1.7.10-SNAPSHOT +dokka_version=1.7.10 dokka_integration_test_parallelism=2 # Versions kotlin_version=1.7.10 diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 0aacbccd48..ad4d48ad68 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.0-SNAPSHOT" +version = "1.7.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 738b047f16..2c063d1e64 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( - """Basic Project 1.7.0-SNAPSHOT API """ in indexFile.readText(), + """Basic Project 1.7.10-SNAPSHOT API """ in indexFile.readText(), "Header with version number not present in index.html" )