From 571624a7362a28ea5179463155742a664e4b39cd Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Mon, 15 Mar 2021 16:45:54 +0100 Subject: Update documentation for 1.4.30 --- docs/src/doc/docs/community/plugins-list.md | 8 ++++---- docs/src/doc/docs/user_guide/gradle/usage.md | 9 ++++++--- 2 files changed, 10 insertions(+), 7 deletions(-) (limited to 'docs/src/doc') diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md index e295ab5c..92b4c3c1 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.4.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.4.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.4.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.4.20/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll) \ No newline at end of file +| [Kotlin as Java](https://kotlin.github.io/dokka/1.4.30/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.4.30/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.4.30/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.4.30/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/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 6a18a1e0..19c10fd4 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -10,7 +10,7 @@ you not only need to add `dokka` to the `build.gradle.kts` file, but you also ne build.gradle.kts: ```kotlin plugins { - id("org.jetbrains.dokka") version "1.4.20" + id("org.jetbrains.dokka") version "1.4.30" } repositories { @@ -97,6 +97,9 @@ dokkaHtml { // Used to remove a source set from documentation, test source sets are suppressed by default suppress.set(false) + + // Used to prevent resolving package-lists online. When this option is set to true, only local files are resolved + offlineMode.set(false) // Use to include or exclude non public members includeNonPublic.set(false) @@ -231,7 +234,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.4.20") + dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.30") } ``` @@ -240,7 +243,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.4.20") + plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.30") } } ``` -- cgit