Skip to content

Commit 3cfc50d

Browse files
IgnatBeresnevIgnatBeresnev
committed
Update Dokka's references to 1.8.20 (#3028)
(cherry picked from commit bb1c151)
1 parent 46c10ac commit 3cfc50d

File tree

37 files changed

+79
-79
lines changed

37 files changed

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

‎README.md

Lines changed: 7 additions & 7 deletions
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.10"
45+
id("org.jetbrains.dokka") version "1.8.20"
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.10'
67+
id 'org.jetbrains.dokka' version '1.8.20'
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.10</version>
101+
<version>1.8.20</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.10")
140+
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.20")
141141
}
142142
```
143143

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

149149
```groovy
150150
dependencies {
151-
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.10'
151+
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.20'
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.10</version>
170+
<version>1.8.20</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.10/developer_guide/introduction/).
217+
[Developer guides](https://kotlin.github.io/dokka/1.8.20/developer_guide/introduction/).
218218

219219
## Community
220220

‎build-logic/src/main/kotlin/org/jetbrains/conventions/dokka.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ plugins {
99

1010
tasks.dokkaHtml {
1111
onlyIf { !isLocalPublication }
12-
outputDirectory.set(layout.buildDirectory.dir("dokka").map { it.asFile })
12+
outputDirectory.set(layout.buildDirectory.dir("dokka"))
1313
}

‎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.8.10"
7+
value="1.8.20"
88
type="string"/>
99
<var name="kotlinVersion"
10-
value="1.8.10"
10+
value="1.8.20"
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
@@ -3,13 +3,13 @@ import org.jetbrains.dokka.base.DokkaBase
33
import org.jetbrains.dokka.base.DokkaBaseConfiguration
44

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

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

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

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

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

99
repositories {

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
2-
kotlin("jvm") version "1.8.10"
3-
id("org.jetbrains.dokka") version "1.8.10"
2+
kotlin("jvm") version "1.8.20"
3+
id("org.jetbrains.dokka") version "1.8.20"
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.10")
14+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.20")
1515

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

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
2-
kotlin("jvm") version "1.8.10"
3-
id("org.jetbrains.dokka") version "1.8.10"
2+
kotlin("jvm") version "1.8.20"
3+
id("org.jetbrains.dokka") version "1.8.20"
44
`java-library`
55
`maven-publish`
66
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
kotlinVersion=1.8.10
2-
dokkaVersion=1.8.10
1+
kotlinVersion=1.8.20
2+
dokkaVersion=1.8.20

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

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

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

1111
repositories {

0 commit comments

Comments
 (0)