diff options
author | Ignat Beresnev <ignat@beresnev.me> | 2021-12-27 18:55:35 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-27 18:55:35 +0300 |
commit | a9283f3652785640ba482b158ac785fbfbaf1f05 (patch) | |
tree | 0075f02cf2b46332e67e4b80f4e5c9628ce62dd5 | |
parent | 39f45564edd22b0c51752ff8ab9a2caa66e37220 (diff) | |
download | dokka-a9283f3652785640ba482b158ac785fbfbaf1f05.tar.gz dokka-a9283f3652785640ba482b158ac785fbfbaf1f05.tar.bz2 dokka-a9283f3652785640ba482b158ac785fbfbaf1f05.zip |
Update Dokka examples and readme to 1.6.10 (#2293)
13 files changed, 41 insertions, 41 deletions
@@ -7,7 +7,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.6.0/](https://kotlin.github.io/dokka/1.6.0/)** +**Full documentation is available at [https://kotlin.github.io/dokka/1.6.10/](https://kotlin.github.io/dokka/1.6.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 @@ -18,7 +18,7 @@ The preferred way is to use `plugins` block. build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.6.0" + id("org.jetbrains.dokka") version "1.6.10" } repositories { @@ -33,7 +33,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.6.0") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") } ``` @@ -42,7 +42,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.6.0") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") } } ``` diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index 9323bacb..48ac732e 100644 --- a/docs/src/doc/docs/community/plugins-list.md +++ b/docs/src/doc/docs/community/plugins-list.md @@ -9,7 +9,7 @@ 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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.10/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll) diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md index eca68c7d..9f09c894 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.6.0.jar", - "libs/kotlin-stdlib-common-1.6.0.jar" + "libs/kotlin-stdlib-1.6.10.jar", + "libs/kotlin-stdlib-common-1.6.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.6.0.jar", + "plugins/dokka-base-1.6.10.jar", "libs/kotlinx-html-jvm-0.7.3.jar", - "libs/dokka-analysis-1.6.0.jar", - "libs/kotlin-analysis-intellij-1.6.0.jar", - "libs/kotlin-analysis-compiler-1.6.0.jar" + "libs/dokka-analysis-1.6.10.jar", + "libs/kotlin-analysis-intellij-1.6.10.jar", + "libs/kotlin-analysis-compiler-1.6.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 0b09b430..5e2fea37 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.6.0" + id("org.jetbrains.dokka") version "1.6.10" } repositories { @@ -263,7 +263,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.6.0") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") } ``` @@ -272,7 +272,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.6.0") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") } } ``` @@ -305,7 +305,7 @@ For example, you can add `DokkaBase` to gain access to aforementioned configurat buildscript { dependencies { // classpath("<plugin coordinates>:<plugin version>") - classpath("org.jetbrains.dokka:dokka-base:1.6.0") + classpath("org.jetbrains.dokka:dokka-base:1.6.10") } } ``` diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts index dd17795b..179f0394 100644 --- a/examples/gradle/dokka-customFormat-example/build.gradle.kts +++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts @@ -1,13 +1,13 @@ import org.jetbrains.dokka.gradle.DokkaTask plugins { - kotlin("jvm") version "1.6.0" - id("org.jetbrains.dokka") version ("1.6.0") + kotlin("jvm") version "1.6.10" + id("org.jetbrains.dokka") version ("1.6.10") } buildscript { dependencies { - classpath("org.jetbrains.dokka:dokka-base:1.6.0") + classpath("org.jetbrains.dokka:dokka-base:1.6.10") } } diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index 8852cc92..fb1127e5 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.6.0" - id("org.jetbrains.dokka") version ("1.6.0") + kotlin("jvm") version "1.6.10" + id("org.jetbrains.dokka") version ("1.6.10") } repositories { diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts index a22aa1d9..7dc5abc8 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.6.0" - id("org.jetbrains.dokka") version ("1.6.0") + kotlin("jvm") version "1.6.10" + id("org.jetbrains.dokka") version ("1.6.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.6.0") + dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") // Will apply the plugin only to the `:dokkaHtml` task - //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0") + //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") // Will apply the plugin only to the `:dokkaGfm` task - //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0") + //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") } diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts index 14cb1c32..cf1f5086 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.6.0" - id("org.jetbrains.dokka") version ("1.6.0") + kotlin("jvm") version "1.6.10" + id("org.jetbrains.dokka") version ("1.6.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 c864e286..be28811b 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.5.30" - id("org.jetbrains.dokka") version ("1.5.30") + kotlin("jvm") version "1.6.10" + id("org.jetbrains.dokka") version ("1.6.10") } } diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts index efbee91e..996eaf94 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.6.0" - id("org.jetbrains.dokka") version "1.6.0" + kotlin("multiplatform") version "1.6.10" + id("org.jetbrains.dokka") version "1.6.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 ec77db84..3744f757 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.6.0" - id("org.jetbrains.dokka") version ("1.6.0") apply false + kotlin("jvm") version "1.6.10" + id("org.jetbrains.dokka") version ("1.6.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.6.0") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.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 3abd1ab3..1093e3e8 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<DokkaMultiModuleTask>("dokkaPreviouslyDocumentation") { dependencies { - dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.6.0") - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.0") + dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.6.10") + dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.6.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 888ca3e1..13247f1f 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.6.0</kotlin.version> - <dokka.version>1.6.0</dokka.version> + <kotlin.version>1.6.10</kotlin.version> + <dokka.version>1.6.10</dokka.version> </properties> <dependencies> |