Skip to content

Commit cea2574

Browse files
committed
Update Kotlin/Dokka version references to 1.9.20 (#3510)
(cherry picked from commit 7ccc48e)
1 parent ff47f23 commit cea2574

File tree

19 files changed

+58
-58
lines changed

19 files changed

+58
-58
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Bug reports, feature requests and questions are welcome. Submit issues [here](ht
2323

2424
## Submitting PRs
2525

26-
Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.10/developer_guide/introduction/) documentation
27-
which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.10/developer_guide/workflow/) and
28-
[Dokka's architecture](https://kotlin.github.io/dokka/1.9.10/developer_guide/architecture/architecture_overview/),
26+
Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.20/developer_guide/introduction/) documentation
27+
which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.20/developer_guide/workflow/) and
28+
[Dokka's architecture](https://kotlin.github.io/dokka/1.9.20/developer_guide/architecture/architecture_overview/),
2929
which can help you understand how to achieve what you want and where to look.
3030

3131
All development (both new features and bugfixes) takes place in the `master` branch, it contains sources for the next
@@ -61,18 +61,18 @@ Unit tests which are run as part of `build` should not take much time, but you c
6161
### Use/test locally built Dokka
6262

6363
Below you will find a bare-bones instruction on how to use and test locally built Dokka. For more details and examples,
64-
visit [Workflow](https://kotlin.github.io/dokka/1.9.10/developer_guide/workflow/) topic.
64+
visit [Workflow](https://kotlin.github.io/dokka/1.9.20/developer_guide/workflow/) topic.
6565

6666
1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
67-
For instance, you can set it to something like `1.9.10-my-fix-SNAPSHOT`.
67+
For instance, you can set it to something like `1.9.20-my-fix-SNAPSHOT`.
6868
2. Publish it to Maven Local (`./gradlew publishToMavenLocal`)
6969
3. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency
7070
repository (`mavenLocal()`)
7171
4. Update your Dokka dependency to the version you've just published:
7272

7373
```kotlin
7474
plugins {
75-
id("org.jetbrains.dokka") version "1.9.10-my-fix-SNAPSHOT"
75+
id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT"
7676
}
7777
```
7878

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project:
4343

4444
```kotlin
4545
plugins {
46-
id("org.jetbrains.dokka") version "1.9.10"
46+
id("org.jetbrains.dokka") version "1.9.20"
4747
}
4848
```
4949

@@ -65,7 +65,7 @@ Apply Gradle plugin for Dokka in the root project:
6565

6666
```groovy
6767
plugins {
68-
id 'org.jetbrains.dokka' version '1.9.10'
68+
id 'org.jetbrains.dokka' version '1.9.20'
6969
}
7070
```
7171

@@ -99,7 +99,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file:
9999
<plugin>
100100
<groupId>org.jetbrains.dokka</groupId>
101101
<artifactId>dokka-maven-plugin</artifactId>
102-
<version>1.9.10</version>
102+
<version>1.9.20</version>
103103
<executions>
104104
<execution>
105105
<phase>pre-site</phase>
@@ -138,7 +138,7 @@ Android platform:
138138

139139
```kotlin
140140
dependencies {
141-
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.10")
141+
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.20")
142142
}
143143
```
144144

@@ -149,7 +149,7 @@ dependencies {
149149

150150
```groovy
151151
dependencies {
152-
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.10'
152+
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.20'
153153
}
154154
```
155155

@@ -168,7 +168,7 @@ dependencies {
168168
<plugin>
169169
<groupId>org.jetbrains.dokka</groupId>
170170
<artifactId>android-documentation-plugin</artifactId>
171-
<version>1.9.10</version>
171+
<version>1.9.20</version>
172172
</plugin>
173173
</dokkaPlugins>
174174
</configuration>
@@ -215,7 +215,7 @@ implement plugins for missing or very specific features that are not provided ou
215215
Learn more about Dokka plugins and their configuration in [Dokka plugins](https://kotlinlang.org/docs/dokka-plugins.html).
216216

217217
If you want to learn how to develop Dokka plugins, see
218-
[Developer guides](https://kotlin.github.io/dokka/1.9.10/developer_guide/introduction/).
218+
[Developer guides](https://kotlin.github.io/dokka/1.9.20/developer_guide/introduction/).
219219

220220
## Community
221221

docs-developer/src/doc/docs/developer_guide/workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Having built Dokka locally, you can publish it to `mavenLocal()`. This will allo
4242
project as well as debug code remotely.
4343

4444
1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
45-
For instance, you can set it to something like `1.9.10-my-fix-SNAPSHOT`. This version will be propagated to plugins
45+
For instance, you can set it to something like `1.9.20-my-fix-SNAPSHOT`. This version will be propagated to plugins
4646
that reside inside Dokka's project (such as `mathjax`, `kotlin-as-java`, etc).
4747
2. Publish it to Maven Local (`./gradlew publishToMavenLocal`). Corresponding artifacts should appear in `~/.m2`
4848
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 {
5555
4. Update your Dokka dependency to the version you've just published:
5656
```kotlin
5757
plugins {
58-
id("org.jetbrains.dokka") version "1.9.10-my-fix-SNAPSHOT"
58+
id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT"
5959
}
6060
```
6161

dokka-subprojects/plugin-kotlin-as-java/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Kotlin as Java plugin is published to maven central as a
88
[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin):
99

1010
```text
11-
org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10
11+
org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20
1212
```
1313

1414
**This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to

dokka-subprojects/plugin-mathjax/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ The MathJax plugin is published to Maven Central as a
2323
[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/mathjax-plugin):
2424

2525
```text
26-
org.jetbrains.dokka:mathjax-plugin:1.9.10
26+
org.jetbrains.dokka:mathjax-plugin:1.9.20
2727
```

dokka-subprojects/plugin-versioning/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can apply the versioning plugin the same way as other Dokka plugins:
1919

2020
```kotlin
2121
dependencies {
22-
dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.9.10")
22+
dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20")
2323
}
2424
```
2525

@@ -33,7 +33,7 @@ plugin within subprojects as well as in their parent project.
3333

3434
```groovy
3535
dependencies {
36-
dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.10'
36+
dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.20'
3737
}
3838
```
3939

@@ -55,7 +55,7 @@ plugin within subprojects as well as in their parent project.
5555
<plugin>
5656
<groupId>org.jetbrains.dokka</groupId>
5757
<artifactId>versioning-plugin</artifactId>
58-
<version>1.9.10</version>
58+
<version>1.9.20</version>
5959
</plugin>
6060
</dokkaPlugins>
6161
</configuration>
@@ -68,15 +68,15 @@ plugin within subprojects as well as in their parent project.
6868
<summary>CLI</summary>
6969

7070
You can find the versioning plugin's artifact on
71-
[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.9.10) or by browsing
72-
[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.10)
71+
[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.9.20) or by browsing
72+
[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.20)
7373
directly, and pass it to `pluginsClasspath`.
7474

7575
Via command line arguments:
7676

7777
```Bash
78-
java -jar dokka-cli-1.9.10.jar \
79-
-pluginsClasspath "./dokka-base-1.9.10.jar;...;./versioning-plugin-1.9.10.jar" \
78+
java -jar dokka-cli-1.9.20.jar \
79+
-pluginsClasspath "./dokka-base-1.9.20.jar;...;./versioning-plugin-1.9.20.jar" \
8080
...
8181
```
8282

@@ -86,9 +86,9 @@ Via JSON configuration:
8686
{
8787
...
8888
"pluginsClasspath": [
89-
"./dokka-base-1.9.10.jar",
89+
"./dokka-base-1.9.20.jar",
9090
"...",
91-
"./versioning-plugin-1.9.10.jar"
91+
"./versioning-plugin-1.9.20.jar"
9292
],
9393
...
9494
}
@@ -135,7 +135,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration
135135

136136
buildscript {
137137
dependencies {
138-
classpath("org.jetbrains.dokka:versioning-plugin:1.9.10")
138+
classpath("org.jetbrains.dokka:versioning-plugin:1.9.20")
139139
}
140140
}
141141

@@ -232,7 +232,7 @@ dokkaHtml {
232232
<summary>CLI</summary>
233233

234234
```Bash
235-
java -jar dokka-cli-1.9.10.jar \
235+
java -jar dokka-cli-1.9.20.jar \
236236
...
237237
-pluginsConfiguration "org.jetbrains.dokka.versioning.VersioningPlugin={\"version\": \"1.5\", \"versionsOrdering\": [\"1.5\", \"1.4\", \"1.3\", \"1.2\", \"1.1\", \"alpha-2\", \"alpha-1\"], \"olderVersionsDir\": \"documentation/version\", \"olderVersions\": [\"documentation/alpha/alpha-2\", \"documentation/alpha/alpha-1\"], \"renderVersionsNavigationOnAllPages\": true}"
238238

@@ -290,12 +290,12 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration
290290

291291
buildscript {
292292
dependencies {
293-
classpath("org.jetbrains.dokka:versioning-plugin:1.9.10")
293+
classpath("org.jetbrains.dokka:versioning-plugin:1.9.20")
294294
}
295295
}
296296

297297
dependencies {
298-
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.10")
298+
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20")
299299
}
300300

301301
tasks.dokkaHtml {

examples/gradle/dokka-customFormat-example/build.gradle.kts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import org.jetbrains.dokka.base.DokkaBase
77
import org.jetbrains.dokka.base.DokkaBaseConfiguration
88

99
plugins {
10-
kotlin("jvm") version "1.9.10"
11-
id("org.jetbrains.dokka") version "1.9.10"
10+
kotlin("jvm") version "1.9.22"
11+
id("org.jetbrains.dokka") version "1.9.20"
1212
}
1313

1414
buildscript {
1515
dependencies {
16-
classpath("org.jetbrains.dokka:dokka-base:1.9.10")
16+
classpath("org.jetbrains.dokka:dokka-base:1.9.20")
1717
}
1818
}
1919

examples/gradle/dokka-gradle-example/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import org.jetbrains.dokka.gradle.DokkaTask
66
import java.net.URL
77

88
plugins {
9-
kotlin("jvm") version "1.9.10"
10-
id("org.jetbrains.dokka") version "1.9.10"
9+
kotlin("jvm") version "1.9.22"
10+
id("org.jetbrains.dokka") version "1.9.20"
1111
}
1212

1313
repositories {

examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
*/
44

55
plugins {
6-
kotlin("jvm") version "1.9.10"
7-
id("org.jetbrains.dokka") version "1.9.10"
6+
kotlin("jvm") version "1.9.22"
7+
id("org.jetbrains.dokka") version "1.9.20"
88
}
99

1010
repositories {
@@ -15,11 +15,11 @@ dependencies {
1515
testImplementation(kotlin("test-junit"))
1616

1717
// Will apply the plugin to all Dokka tasks
18-
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10")
18+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20")
1919

2020
// Will apply the plugin only to the `:dokkaHtml` task
21-
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10")
21+
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20")
2222

2323
// Will apply the plugin only to the `:dokkaGfm` task
24-
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10")
24+
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.20")
2525
}

examples/gradle/dokka-library-publishing-example/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
*/
44

55
plugins {
6-
kotlin("jvm") version "1.9.10"
7-
id("org.jetbrains.dokka") version "1.9.10"
6+
kotlin("jvm") version "1.9.22"
7+
id("org.jetbrains.dokka") version "1.9.20"
88
`java-library`
99
`maven-publish`
1010
}

0 commit comments

Comments
 (0)