Skip to content

Commit 78f9c92

Browse files
IgnatBeresnevIgnatBeresnev
committed
Update Dokka's references to 1.9.10 (#3210)
(cherry picked from commit 9bbcc21)
1 parent 2a2a624 commit 78f9c92

File tree

23 files changed

+63
-63
lines changed

23 files changed

+63
-63
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.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/),
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/),
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.0/developer_guide/workflow/) topic.
64+
visit [Workflow](https://kotlin.github.io/dokka/1.9.10/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.0-my-fix-SNAPSHOT`.
67+
For instance, you can set it to something like `1.9.10-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.0-my-fix-SNAPSHOT"
75+
id("org.jetbrains.dokka") version "1.9.10-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.0"
46+
id("org.jetbrains.dokka") version "1.9.10"
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.0'
68+
id 'org.jetbrains.dokka' version '1.9.10'
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.0</version>
102+
<version>1.9.10</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.0")
141+
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.10")
142142
}
143143
```
144144

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

150150
```groovy
151151
dependencies {
152-
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.0'
152+
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.10'
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.0</version>
171+
<version>1.9.10</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.0/developer_guide/introduction/).
218+
[Developer guides](https://kotlin.github.io/dokka/1.9.10/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.0-my-fix-SNAPSHOT`. This version will be propagated to plugins
45+
For instance, you can set it to something like `1.9.10-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.0-my-fix-SNAPSHOT"
58+
id("org.jetbrains.dokka") version "1.9.10-my-fix-SNAPSHOT"
5959
}
6060
```
6161

‎docs/v.list

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
<vars>
66
<var name="dokkaVersion"
7-
value="1.9.0"
7+
value="1.9.10"
88
type="string"/>
99
<var name="kotlinVersion"
10-
value="1.9.0"
10+
value="1.9.10"
1111
type="string"/>
1212
</vars>

‎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.0"
11-
id("org.jetbrains.dokka") version "1.9.0"
10+
kotlin("jvm") version "1.9.10"
11+
id("org.jetbrains.dokka") version "1.9.10"
1212
}
1313

1414
buildscript {
1515
dependencies {
16-
classpath("org.jetbrains.dokka:dokka-base:1.9.0")
16+
classpath("org.jetbrains.dokka:dokka-base:1.9.10")
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.0"
10-
id("org.jetbrains.dokka") version "1.9.0"
9+
kotlin("jvm") version "1.9.10"
10+
id("org.jetbrains.dokka") version "1.9.10"
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.0"
7-
id("org.jetbrains.dokka") version "1.9.0"
6+
kotlin("jvm") version "1.9.10"
7+
id("org.jetbrains.dokka") version "1.9.10"
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.0")
18+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10")
1919

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

2323
// Will apply the plugin only to the `:dokkaGfm` task
24-
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.0")
24+
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10")
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.0"
7-
id("org.jetbrains.dokka") version "1.9.0"
6+
kotlin("jvm") version "1.9.10"
7+
id("org.jetbrains.dokka") version "1.9.10"
88
`java-library`
99
`maven-publish`
1010
}

‎examples/gradle/dokka-multimodule-example/gradle.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
# Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
33
#
44

5-
kotlinVersion=1.9.0
6-
dokkaVersion=1.9.0
5+
kotlinVersion=1.9.10
6+
dokkaVersion=1.9.10

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import org.jetbrains.dokka.gradle.DokkaTask
88
import org.jetbrains.dokka.Platform
99

1010
plugins {
11-
kotlin("multiplatform") version "1.9.0"
12-
id("org.jetbrains.dokka") version "1.9.0"
11+
kotlin("multiplatform") version "1.9.10"
12+
id("org.jetbrains.dokka") version "1.9.10"
1313
}
1414

1515
repositories {

0 commit comments

Comments
 (0)