diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2022-04-25 22:27:12 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-25 22:27:12 +0300 |
commit | 52d066c10a50b0e34f1c390c965a89ae403e07a9 (patch) | |
tree | f4dff036c29625fae1130be63b3fa205fd45f44e /docs/src/doc | |
parent | b1acc183368da3352a8b61614f0b943ae865b18b (diff) | |
download | dokka-52d066c10a50b0e34f1c390c965a89ae403e07a9.tar.gz dokka-52d066c10a50b0e34f1c390c965a89ae403e07a9.tar.bz2 dokka-52d066c10a50b0e34f1c390c965a89ae403e07a9.zip |
Update documentation and examples to Dokka 1.6.21 (#2465)
Diffstat (limited to 'docs/src/doc')
-rw-r--r-- | docs/src/doc/docs/community/plugins-list.md | 8 | ||||
-rw-r--r-- | docs/src/doc/docs/user_guide/base-specific/frontend.md | 2 | ||||
-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 |
4 files changed, 15 insertions, 15 deletions
diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index a3d604e6..ea9b5cc7 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.6.20/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.20/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.20/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.20/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.21/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.21/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.21/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.21/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 0e31aa48..dbe4357f 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.6.20/user_guide/versioning/versioning/) will replace this with a version navigator) +* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.6.21/user_guide/versioning/versioning/) will replace this with a version navigator) * `<@template_cmd name="...""> ...</@template_cmd>` - 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 f3c816b8..2d49ff00 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.20.jar", - "libs/kotlin-stdlib-common-1.6.20.jar" + "libs/kotlin-stdlib-1.6.21.jar", + "libs/kotlin-stdlib-common-1.6.21.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.20.jar", + "plugins/dokka-base-1.6.21.jar", "libs/kotlinx-html-jvm-0.7.3.jar", - "libs/dokka-analysis-1.6.20.jar", - "libs/kotlin-analysis-intellij-1.6.20.jar", - "libs/kotlin-analysis-compiler-1.6.20.jar" + "libs/dokka-analysis-1.6.21.jar", + "libs/kotlin-analysis-intellij-1.6.21.jar", + "libs/kotlin-analysis-compiler-1.6.21.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 982923fc..e442e265 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.20" + id("org.jetbrains.dokka") version "1.6.21" } 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.6.20") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } ``` @@ -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.6.20") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.21") } } ``` @@ -311,7 +311,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.20") + classpath("org.jetbrains.dokka:dokka-base:1.6.21") } } ``` |