diff options
author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2022-06-20 16:17:20 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-20 16:17:20 +0200 |
commit | fc86d2125db751fcb93ed25e1d8e87577adcaa6a (patch) | |
tree | ce8de0394cfc8619f40035875b4f63bc8c1f47db /docs/src/doc | |
parent | a9b86d78c90ed18a838ed76dbd0468799c77c13f (diff) | |
download | dokka-fc86d2125db751fcb93ed25e1d8e87577adcaa6a.tar.gz dokka-fc86d2125db751fcb93ed25e1d8e87577adcaa6a.tar.bz2 dokka-fc86d2125db751fcb93ed25e1d8e87577adcaa6a.zip |
Update documentation and examples to Dokka 1.7.0 (#2542)
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 | 4 | ||||
-rw-r--r-- | docs/src/doc/docs/user_guide/cli/usage.md | 14 | ||||
-rw-r--r-- | docs/src/doc/docs/user_guide/gradle/usage.md | 8 |
4 files changed, 17 insertions, 17 deletions
diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index ea9b5cc7..4a65965e 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.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) +| [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) | [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 dbe4357f..f1de420d 100644 --- a/docs/src/doc/docs/user_guide/base-specific/frontend.md +++ b/docs/src/doc/docs/user_guide/base-specific/frontend.md @@ -99,11 +99,11 @@ 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.21/user_guide/versioning/versioning/) will replace this with a version navigator) +* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.0/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: ``` <@template_cmd name="projectName"> <span>${projectName}</span> </@template_cmd> - ```
\ No newline at end of file + ``` diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md index 2d49ff00..a489979d 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.21.jar", - "libs/kotlin-stdlib-common-1.6.21.jar" + "libs/kotlin-stdlib-1.7.0.jar", + "libs/kotlin-stdlib-common-1.7.0.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.21.jar", + "plugins/dokka-base-1.7.0.jar", "libs/kotlinx-html-jvm-0.7.3.jar", - "libs/dokka-analysis-1.6.21.jar", - "libs/kotlin-analysis-intellij-1.6.21.jar", - "libs/kotlin-analysis-compiler-1.6.21.jar" + "libs/dokka-analysis-1.7.0.jar", + "libs/kotlin-analysis-intellij-1.7.0.jar", + "libs/kotlin-analysis-compiler-1.7.0.jar" ], "pluginsConfiguration": [ { @@ -155,4 +155,4 @@ The content of JSON file ```dokkaConfiguration.json```: "includes": [], "suppressInheritedMembers": false } -```
\ No newline at end of file +``` diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 2c17ceb5..399075a5 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.21" + id("org.jetbrains.dokka") version "1.7.0" } 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.21") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") } ``` @@ -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.21") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0") } } ``` @@ -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.21") + classpath("org.jetbrains.dokka:dokka-base:1.7.0") } } ``` |