aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2022-10-12 15:10:34 +0200
committerGitHub <noreply@github.com>2022-10-12 15:10:34 +0200
commit25bc442c783bb94899bb02de0f01af092f82ae81 (patch)
treef1daafe8723caf74fa70d3fe4568c4ebddbccd69 /docs/src
parent83174361becb2af227159834cdf6e14db9300c53 (diff)
downloaddokka-25bc442c783bb94899bb02de0f01af092f82ae81.tar.gz
dokka-25bc442c783bb94899bb02de0f01af092f82ae81.tar.bz2
dokka-25bc442c783bb94899bb02de0f01af092f82ae81.zip
Update documentation and examples for 1.7.20 (#2697)
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/doc/docs/community/plugins-list.md2
-rw-r--r--docs/src/doc/docs/developer_guide/workflow.md4
-rw-r--r--docs/src/doc/docs/user_guide/applying/cli.md12
-rw-r--r--docs/src/doc/docs/user_guide/applying/gradle.md8
4 files changed, 13 insertions, 13 deletions
diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md
index e43dcbf3..6ae8ce4c 100644
--- a/docs/src/doc/docs/community/plugins-list.md
+++ b/docs/src/doc/docs/community/plugins-list.md
@@ -155,6 +155,6 @@ For instance, `fun foo(bar: Bar): Baz` will be rendered as `public final Baz foo
`Kotlin as Java` plugin is published to maven central as a
[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin):
-`org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10`.
+`org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20`.
[Plugin source code on GitHub](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java)
diff --git a/docs/src/doc/docs/developer_guide/workflow.md b/docs/src/doc/docs/developer_guide/workflow.md
index d3805cbc..ddf37459 100644
--- a/docs/src/doc/docs/developer_guide/workflow.md
+++ b/docs/src/doc/docs/developer_guide/workflow.md
@@ -42,7 +42,7 @@ Having built Dokka locally, you can publish it to `mavenLocal()`. This will allo
project as well as debug code remotely.
1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
- For instance, you can set it to something like `1.7.10-my-fix-SNAPSHOT`. This version will be propagated to plugins
+ For instance, you can set it to something like `1.7.20-my-fix-SNAPSHOT`. This version will be propagated to plugins
that reside inside Dokka's project (such as `mathjax`, `kotlin-as-java`, etc).
2. Publish it to maven local (`./gradlew publishToMavenLocal`). Corresponding artifacts should appear in `~/.m2`
3. In the project you want to generate documentation for or debug on, add maven local as a plugin/dependency
@@ -55,7 +55,7 @@ repositories {
4. Update your dokka dependency to the version you've just published:
```kotlin
plugins {
- id("org.jetbrains.dokka") version "1.7.10-my-fix-SNAPSHOT"
+ id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT"
}
```
diff --git a/docs/src/doc/docs/user_guide/applying/cli.md b/docs/src/doc/docs/user_guide/applying/cli.md
index b0bac3fb..3b02add2 100644
--- a/docs/src/doc/docs/user_guide/applying/cli.md
+++ b/docs/src/doc/docs/user_guide/applying/cli.md
@@ -93,8 +93,8 @@ The content of JSON file ```dokkaConfiguration.json```:
"sourceSetName": "main"
},
"classpath": [
- "libs/kotlin-stdlib-1.7.10.jar",
- "libs/kotlin-stdlib-common-1.7.10.jar"
+ "libs/kotlin-stdlib-1.7.20.jar",
+ "libs/kotlin-stdlib-common-1.7.20.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.7.10.jar",
+ "plugins/dokka-base-1.7.20.jar",
"libs/kotlinx-html-jvm-0.7.3.jar",
- "libs/dokka-analysis-1.7.10.jar",
- "libs/kotlin-analysis-intellij-1.7.10.jar",
- "libs/kotlin-analysis-compiler-1.7.10.jar"
+ "libs/dokka-analysis-1.7.20.jar",
+ "libs/kotlin-analysis-intellij-1.7.20.jar",
+ "libs/kotlin-analysis-compiler-1.7.20.jar"
],
"pluginsConfiguration": [
{
diff --git a/docs/src/doc/docs/user_guide/applying/gradle.md b/docs/src/doc/docs/user_guide/applying/gradle.md
index 0ab1ff8a..30d23346 100644
--- a/docs/src/doc/docs/user_guide/applying/gradle.md
+++ b/docs/src/doc/docs/user_guide/applying/gradle.md
@@ -14,7 +14,7 @@ The preferred way is to use `plugins` block.
build.gradle.kts:
```kotlin
plugins {
- id("org.jetbrains.dokka") version "1.7.10"
+ id("org.jetbrains.dokka") version "1.7.20"
}
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.7.10")
+ dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
```
@@ -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.7.10")
+ plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
}
```
@@ -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.7.10")
+ classpath("org.jetbrains.dokka:dokka-base:1.7.20")
}
}
```