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 /docs | |
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)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/src/doc/docs/community/plugins-list.md | 8 | ||||
-rw-r--r-- | docs/src/doc/docs/user_guide/cli/usage.md | 12 | ||||
-rw-r--r-- | docs/src/doc/docs/user_guide/gradle/usage.md | 8 |
3 files changed, 14 insertions, 14 deletions
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") } } ``` |