Skip to content

Commit ff75c00

Browse files
committed
Update Dokka's references to 1.9.0
1 parent 4096e7d commit ff75c00

File tree

22 files changed

+52
-52
lines changed

22 files changed

+52
-52
lines changed

CONTRIBUTING.md

+6-6
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.8.20/developer_guide/introduction/) documentation
27-
which goes over the development [Workflow](https://kotlin.github.io/dokka/1.8.20/developer_guide/workflow/) and
28-
[Dokka's architecture](https://kotlin.github.io/dokka/1.8.20/developer_guide/architecture/architecture_overview/),
26+
Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.9.0/developer_guide/introduction/) documentation
27+
which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.0/developer_guide/workflow/) and
28+
[Dokka's architecture](https://kotlin.github.io/dokka/1.9.0/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.8.20/developer_guide/workflow/) topic.
64+
visit [Workflow](https://kotlin.github.io/dokka/1.9.0/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.8.20-my-fix-SNAPSHOT`.
67+
For instance, you can set it to something like `1.9.0-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.8.20-my-fix-SNAPSHOT"
75+
id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT"
7676
}
7777
```
7878

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project:
4242

4343
```kotlin
4444
plugins {
45-
id("org.jetbrains.dokka") version "1.8.20"
45+
id("org.jetbrains.dokka") version "1.9.0"
4646
}
4747
```
4848

@@ -64,7 +64,7 @@ Apply Gradle plugin for Dokka in the root project:
6464

6565
```groovy
6666
plugins {
67-
id 'org.jetbrains.dokka' version '1.8.20'
67+
id 'org.jetbrains.dokka' version '1.9.0'
6868
}
6969
```
7070

@@ -98,7 +98,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file:
9898
<plugin>
9999
<groupId>org.jetbrains.dokka</groupId>
100100
<artifactId>dokka-maven-plugin</artifactId>
101-
<version>1.8.20</version>
101+
<version>1.9.0</version>
102102
<executions>
103103
<execution>
104104
<phase>pre-site</phase>
@@ -137,7 +137,7 @@ Android platform:
137137

138138
```kotlin
139139
dependencies {
140-
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.20")
140+
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.0")
141141
}
142142
```
143143

@@ -148,7 +148,7 @@ dependencies {
148148

149149
```groovy
150150
dependencies {
151-
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.20'
151+
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.0'
152152
}
153153
```
154154

@@ -167,7 +167,7 @@ dependencies {
167167
<plugin>
168168
<groupId>org.jetbrains.dokka</groupId>
169169
<artifactId>android-documentation-plugin</artifactId>
170-
<version>1.8.20</version>
170+
<version>1.9.0</version>
171171
</plugin>
172172
</dokkaPlugins>
173173
</configuration>
@@ -214,7 +214,7 @@ implement plugins for missing or very specific features that are not provided ou
214214
Learn more about Dokka plugins and their configuration in [Dokka plugins](https://kotlinlang.org/docs/dokka-plugins.html).
215215

216216
If you want to learn how to develop Dokka plugins, see
217-
[Developer guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/).
217+
[Developer guides](https://kotlin.github.io/dokka/1.9.0/developer_guide/introduction/).
218218

219219
## Community
220220

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

+2-2
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.8.20-my-fix-SNAPSHOT`. This version will be propagated to plugins
45+
For instance, you can set it to something like `1.9.0-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.8.20-my-fix-SNAPSHOT"
58+
id("org.jetbrains.dokka") version "1.9.0-my-fix-SNAPSHOT"
5959
}
6060
```
6161

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ import org.jetbrains.dokka.base.DokkaBaseConfiguration
44

55
plugins {
66
kotlin("jvm") version "1.9.0"
7-
id("org.jetbrains.dokka") version "1.8.20"
7+
id("org.jetbrains.dokka") version "1.9.0"
88
}
99

1010
buildscript {
1111
dependencies {
12-
classpath("org.jetbrains.dokka:dokka-base:1.8.20")
12+
classpath("org.jetbrains.dokka:dokka-base:1.9.0")
1313
}
1414
}
1515

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import java.net.URL
33

44
plugins {
55
kotlin("jvm") version "1.9.0"
6-
id("org.jetbrains.dokka") version "1.8.20"
6+
id("org.jetbrains.dokka") version "1.9.0"
77
}
88

99
repositories {
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
22
kotlin("jvm") version "1.9.0"
3-
id("org.jetbrains.dokka") version "1.8.20"
3+
id("org.jetbrains.dokka") version "1.9.0"
44
}
55

66
repositories {
@@ -11,11 +11,11 @@ dependencies {
1111
testImplementation(kotlin("test-junit"))
1212

1313
// Will apply the plugin to all Dokka tasks
14-
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20")
14+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0")
1515

1616
// Will apply the plugin only to the `:dokkaHtml` task
17-
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20")
17+
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0")
1818

1919
// Will apply the plugin only to the `:dokkaGfm` task
20-
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20")
20+
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0")
2121
}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
22
kotlin("jvm") version "1.9.0"
3-
id("org.jetbrains.dokka") version "1.8.20"
3+
id("org.jetbrains.dokka") version "1.9.0"
44
`java-library`
55
`maven-publish`
66
}
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
kotlinVersion=1.9.0
2-
dokkaVersion=1.8.20
2+
dokkaVersion=1.9.0

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import org.jetbrains.dokka.Platform
55

66
plugins {
77
kotlin("multiplatform") version "1.9.0"
8-
id("org.jetbrains.dokka") version "1.8.20"
8+
id("org.jetbrains.dokka") version "1.9.0"
99
}
1010

1111
repositories {

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
22
kotlin("jvm") version "1.9.0"
3-
id("org.jetbrains.dokka") version "1.8.20" apply false
3+
id("org.jetbrains.dokka") version "1.9.0" apply false
44
}
55

66
// The versioning plugin must be applied in all submodules
@@ -14,6 +14,6 @@ subprojects {
1414
}
1515
val dokkaPlugin by configurations
1616
dependencies {
17-
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20")
17+
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0")
1818
}
1919
}

examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration
44

55
buildscript {
66
dependencies {
7-
classpath("org.jetbrains.dokka:versioning-plugin:1.8.20")
7+
classpath("org.jetbrains.dokka:versioning-plugin:1.9.0")
88
}
99

1010
repositories {

examples/maven/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<version>1.0-SNAPSHOT</version>
1010
<properties>
1111
<kotlin.version>1.9.0</kotlin.version>
12-
<dokka.version>1.8.20</dokka.version>
12+
<dokka.version>1.9.0</dokka.version>
1313
</properties>
1414

1515
<dependencies>

examples/plugin/hide-internal-api/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Hide Internal API plugin example
22

33
This project represents a simple Dokka Plugin that was developed step-by-step in the
4-
[Sample plugin](https://kotlin.github.io/dokka/1.8.20/developer_guide/plugin-development/sample-plugin-tutorial/)
4+
[Sample plugin](https://kotlin.github.io/dokka/1.9.0/developer_guide/plugin-development/sample-plugin-tutorial/)
55
tutorial. This is a frequent request with varying requirements.
66

77
The plugin excludes any declaration that is marked with `org.jetbrains.dokka.internal.test.Internal` annotation.
88
The annotation itself is not provided in this project and is instead matched by the fully qualified name only.
99
You can change it to your own internal annotation or to some other marker that suits you.
1010

1111
To learn how to install and debug it locally,
12-
[see documentation](https://kotlin.github.io/dokka/1.8.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging).
12+
[see documentation](https://kotlin.github.io/dokka/1.9.0/developer_guide/plugin-development/sample-plugin-tutorial/#debugging).
1313

1414
___
1515

examples/plugin/hide-internal-api/build.gradle.kts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import java.net.URI
44

55
plugins {
66
kotlin("jvm") version "1.9.0"
7-
id("org.jetbrains.dokka") version "1.8.20"
7+
id("org.jetbrains.dokka") version "1.9.0"
88
`maven-publish`
99
signing
1010
}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
dokkaVersion=1.8.20
1+
dokkaVersion=1.9.0

gradle/libs.versions.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
gradlePlugin-kotlin = "1.9.0"
44
# See: https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin
55
gradlePlugin-android = "4.2.2"
6-
gradlePlugin-dokka = "1.8.20"
6+
gradlePlugin-dokka = "1.9.0"
77

88
kotlinx-coroutines = "1.6.3"
99
kotlinx-bcv = "0.12.1"

integration-tests/gradle/projects/it-basic/build.gradle.kts

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ buildscript {
1616
}
1717
}
1818

19-
version = "1.8.20-SNAPSHOT"
19+
version = "1.9.0-SNAPSHOT"
2020

2121
apply(from = "../template.root.gradle.kts")
2222

integration-tests/gradle/projects/it-configuration/build.gradle.kts

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ buildscript {
1212
}
1313
}
1414

15-
version = "1.8.20-SNAPSHOT"
15+
version = "1.9.0-SNAPSHOT"
1616

1717
apply(from = "../template.root.gradle.kts")
1818

integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ class BasicGradleIntegrationTest(override val versions: BuildVersions) : Abstrac
156156
val indexFile = File(this, "index.html")
157157
assertTrue(indexFile.isFile, "Missing index.html")
158158
assertTrue(
159-
"""<title>Basic Project 1.8.20-SNAPSHOT API </title>""" in indexFile.readText(),
159+
"""<title>Basic Project 1.9.0-SNAPSHOT API </title>""" in indexFile.readText(),
160160
"Header with version number not present in index.html"
161161
)
162162

plugins/kotlin-as-java/README.md

+1-1
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.8.20
11+
org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0
1212
```
1313

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

plugins/mathjax/README.md

+1-1
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.8.20
26+
org.jetbrains.dokka:mathjax-plugin:1.9.0
2727
```

plugins/versioning/README.md

+13-13
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.8.20")
22+
dokkaHtmlPlugin("org.jetbrains.dokka:versioning-plugin:1.9.0")
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.8.20'
36+
dokkaHtmlPlugin 'org.jetbrains.dokka:versioning-plugin:1.9.0'
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.8.20</version>
58+
<version>1.9.0</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.8.20) or by browsing
72-
[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.8.20)
71+
[mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/versioning-plugin/1.9.0) or by browsing
72+
[maven central repository](https://repo1.maven.org/maven2/org/jetbrains/dokka/versioning-plugin/1.9.0)
7373
directly, and pass it to `pluginsClasspath`.
7474

7575
Via command line arguments:
7676

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

@@ -86,9 +86,9 @@ Via JSON configuration:
8686
{
8787
...
8888
"pluginsClasspath": [
89-
"./dokka-base-1.8.20.jar",
89+
"./dokka-base-1.9.0.jar",
9090
"...",
91-
"./versioning-plugin-1.8.20.jar"
91+
"./versioning-plugin-1.9.0.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.8.20")
138+
classpath("org.jetbrains.dokka:versioning-plugin:1.9.0")
139139
}
140140
}
141141

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

234234
```Bash
235-
java -jar dokka-cli-1.8.20.jar \
235+
java -jar dokka-cli-1.9.0.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.8.20")
293+
classpath("org.jetbrains.dokka:versioning-plugin:1.9.0")
294294
}
295295
}
296296

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

301301
tasks.dokkaHtml {

0 commit comments

Comments
 (0)