Skip to content

Commit fc574c8

Browse files
authored
Update Kotlin/Dokka version references to 2.0.0 (#3957)
1 parent 272e59e commit fc574c8

File tree

31 files changed

+80
-80
lines changed

31 files changed

+80
-80
lines changed

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ 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.20/developer_guide/introduction/)
26+
Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/2.0.0/developer_guide/introduction/)
2727
documentation
28-
which goes over the development [Workflow](https://kotlin.github.io/dokka/1.9.20/developer_guide/workflow/) and
29-
[Dokka's architecture](https://kotlin.github.io/dokka/1.9.20/developer_guide/architecture/architecture_overview/),
28+
which goes over the development [Workflow](https://kotlin.github.io/dokka/2.0.0/developer_guide/workflow/) and
29+
[Dokka's architecture](https://kotlin.github.io/dokka/2.0.0/developer_guide/architecture/architecture_overview/),
3030
which can help you understand how to achieve what you want and where to look.
3131

3232
All development (both new features and bugfixes) takes place in the `master` branch, it contains sources for the next
@@ -64,16 +64,16 @@ not take much time (~2-5 minutes), so please make sure they pass before submitti
6464
### Use/test locally built Dokka
6565

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

69-
1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=1.9.20-my-fix-SNAPSHOT`
69+
1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=2.0.0-my-fix-SNAPSHOT`
7070
2. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency
7171
repository (`mavenLocal()`)
7272
3. Update your Dokka dependency to the version you've just published:
7373

7474
```kotlin
7575
plugins {
76-
id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT"
76+
id("org.jetbrains.dokka") version "2.0.0-my-fix-SNAPSHOT"
7777
}
7878
```
7979

README.md

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

4545
```kotlin
4646
plugins {
47-
id("org.jetbrains.dokka") version "1.9.20"
47+
id("org.jetbrains.dokka") version "2.0.0"
4848
}
4949
```
5050

@@ -66,7 +66,7 @@ Apply Gradle plugin for Dokka in the root project:
6666

6767
```groovy
6868
plugins {
69-
id 'org.jetbrains.dokka' version '1.9.20'
69+
id 'org.jetbrains.dokka' version '2.0.0'
7070
}
7171
```
7272

@@ -100,7 +100,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file:
100100
<plugin>
101101
<groupId>org.jetbrains.dokka</groupId>
102102
<artifactId>dokka-maven-plugin</artifactId>
103-
<version>1.9.20</version>
103+
<version>2.0.0</version>
104104
<executions>
105105
<execution>
106106
<phase>pre-site</phase>
@@ -139,7 +139,7 @@ which aims to improve documentation experience on the Android platform:
139139

140140
```kotlin
141141
dependencies {
142-
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.20")
142+
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:2.0.0")
143143
}
144144
```
145145

@@ -150,7 +150,7 @@ dependencies {
150150

151151
```groovy
152152
dependencies {
153-
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.20'
153+
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:2.0.0'
154154
}
155155
```
156156

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

218218
If you want to learn how to develop Dokka plugins, see
219-
[Developer guides](https://kotlin.github.io/dokka/1.9.20/developer_guide/introduction/).
219+
[Developer guides](https://kotlin.github.io/dokka/2.0.0/developer_guide/introduction/).
220220

221221
## Community
222222

docs-developer/docs/developer_guide/workflow.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ will review API changes thoroughly, so please make sure it's intentional and rat
4343
Having built Dokka locally, you can publish it to `mavenLocal()`. This will allow you to test your changes in another
4444
project as well as debug code remotely.
4545

46-
1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=1.9.20-my-fix-SNAPSHOT`.
46+
1. Publish a custom version of Dokka to Maven Local: `./gradlew publishToMavenLocal -Pversion=2.0.0-my-fix-SNAPSHOT`.
4747
This version will be propagated to plugins that reside inside Dokka's project (`mathjax`, `kotlin-as-java`, etc),
4848
and its artifacts should appear in `~/.m2`
4949
2. In the project you want to generate documentation for or debug on, add maven local as a plugin/dependency
@@ -56,7 +56,7 @@ repositories {
5656
3. Update your Dokka dependency to the version you've just published:
5757
```kotlin
5858
plugins {
59-
id("org.jetbrains.dokka") version "1.9.20-my-fix-SNAPSHOT"
59+
id("org.jetbrains.dokka") version "2.0.0-my-fix-SNAPSHOT"
6060
}
6161
```
6262

docs/topics/dokka-migration.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Dokka Gradle plugin (DGP) is a tool for generating comprehensive API documen
1010
DGP seamlessly processes both Kotlin's KDoc comments and Java's Javadoc comments to extract information and create
1111
structured documentation in [HTML or Javadoc](#select-documentation-output-format) format.
1212

13-
Starting with Dokka 2.0.0-Beta, you can try the Dokka Gradle plugin v2, the new version of DGP. With Dokka 2.0.0-Beta, you can use
13+
Starting with Dokka 2.0.0, you can try the Dokka Gradle plugin v2, the new version of DGP. With Dokka 2.0.0, you can use
1414
the Dokka Gradle plugin either in v1 or v2 modes.
1515

1616
DGP v2 introduces significant improvements to DGP, aligning more closely with Gradle best practices:
@@ -38,12 +38,12 @@ Ensure that your project meets the minimum version requirements:
3838

3939
### Enable the new Dokka Gradle plugin
4040

41-
1. Update the Dokka version to 2.0.0-Beta in the `plugins {}` block of your project’s `build.gradle.kts` file:
41+
1. Update the Dokka version to 2.0.0 in the `plugins {}` block of your project’s `build.gradle.kts` file:
4242

4343
```kotlin
4444
plugins {
4545
kotlin("jvm") version "1.9.25"
46-
id("org.jetbrains.dokka") version "2.0.0-Beta"
46+
id("org.jetbrains.dokka") version "2.0.0"
4747
}
4848
```
4949

@@ -275,7 +275,7 @@ set up the convention plugin, and then apply the plugin to your modules (subproj
275275
}
276276

277277
dependencies {
278-
implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta")
278+
implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0")
279279
}
280280
```
281281

@@ -386,10 +386,10 @@ or both formats at the same time:
386386
```kotlin
387387
plugins {
388388
// Generates HTML documentation
389-
id("org.jetbrains.dokka") version "2.0.0-Beta"
389+
id("org.jetbrains.dokka") version "2.0.0"
390390

391391
// Generates Javadoc documentation
392-
id("org.jetbrains.dokka-javadoc") version "2.0.0-Beta"
392+
id("org.jetbrains.dokka-javadoc") version "2.0.0"
393393

394394
// Keeping both plugin IDs generates both formats
395395
}
@@ -412,7 +412,7 @@ Here's a list of the plugin `id` and Gradle task that correspond to each format:
412412
413413
### Address deprecations and removals
414414
415-
* **Output format support:** Dokka 2.0.0-Beta only supports HTML and Javadoc output. Experimental formats like Markdown and Jekyll are no longer supported.
415+
* **Output format support:** Dokka 2.0.0 only supports HTML and Javadoc output. Experimental formats like Markdown and Jekyll are no longer supported.
416416
* **Collector task:** `DokkaCollectorTask` has been removed. Now, you need to generate the documentation separately for
417417
each subproject and then [aggregate the documentation](#update-documentation-aggregation-in-multi-module-projects) if necessary.
418418

docs/v.list

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
<vars>
66
<var name="dokkaVersion"
7-
value="1.9.20"
7+
value="2.0.0"
88
type="string"/>
99
<var name="kotlinVersion"
10-
value="1.9.22"
10+
value="2.1.0"
1111
type="string"/>
1212
</vars>

dokka-integration-tests/gradle/projects/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Projects used to run integration tests could be opened in or build independently
44

55
1. open `gradle.properties` file of a specific project and change commented variables:
66
1. `dokka_it_kotlin_version` to required version of Kotlin Gradle Plugin, e.g 2.0.0
7-
2. `dokka_it_dokka_version` to required version to Dokka Gradle plugin, e.g 1.9.20
7+
2. `dokka_it_dokka_version` to required version to Dokka Gradle plugin, e.g 2.0.0
88
3. replace all other commented properties if needed, like `dokka_it_android_gradle_plugin_version`
99
2. open `settings.gradle.kts` and replace `apply(from = "template.settings.gradle.kts")` with
1010
`apply(from = "../template.settings.gradle.kts")` (so the path should be prefixed with `../`)

dokka-subprojects/analysis-kotlin-symbols/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To build it with an override version of Analysis API, the property
2424

2525
### Entry point
2626

27-
The main entry point is `DefaultSymbolToDocumentableTranslator` (this is an extension for [the extension point](https://kotlin.github.io/dokka/1.9.20/developer_guide/architecture/extension_points/core_extensions/#sourcetodocumentabletranslator) ), that is used by the Dokka core to build Documentable model by a source set.
27+
The main entry point is `DefaultSymbolToDocumentableTranslator` (this is an extension for [the extension point](https://kotlin.github.io/dokka/2.0.0/developer_guide/architecture/extension_points/core_extensions/#sourcetodocumentabletranslator) ), that is used by the Dokka core to build Documentable model by a source set.
2828

2929
Across running Dokka we keep `StandaloneAnalysisAPISession` and `KtSourceModule` instances from Analysis API into `KotlinAnalysis`.
3030
`KotlinAnalysis` is used in `DefaultSymbolToDocumentableTranslator` and other services that need an additional analysis.
@@ -51,4 +51,4 @@ By default, we run unit tests on TeamCity against the latest Analysis API by a s
5151
- You can use the `gradle :publishToMavenLocal` task to publish Dokka locally.
5252
- To build Dokka without running testing, using the `gradle assemble` task is recommended since the tests are time-consuming.
5353

54-
See the detailed guide [here](https://kotlin.github.io/dokka/1.9.20/developer_guide/workflow/).
54+
See the detailed guide [here](https://kotlin.github.io/dokka/2.0.0/developer_guide/workflow/).

dokka-subprojects/plugin-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.9.20
11+
org.jetbrains.dokka:kotlin-as-java-plugin:2.0.0
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

+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.9.20
26+
org.jetbrains.dokka:mathjax-plugin:2.0.0
2727
```

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

7575
Via command line arguments:
7676

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

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

137137
buildscript {
138138
dependencies {
139-
classpath("org.jetbrains.dokka:versioning-plugin:1.9.20")
139+
classpath("org.jetbrains.dokka:versioning-plugin:2.0.0")
140140
}
141141
}
142142

@@ -233,7 +233,7 @@ dokkaHtml {
233233
<summary>CLI</summary>
234234

235235
```Bash
236-
java -jar dokka-cli-1.9.20.jar \
236+
java -jar dokka-cli-2.0.0.jar \
237237
...
238238
-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}"
239239

@@ -294,12 +294,12 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration
294294

295295
buildscript {
296296
dependencies {
297-
classpath("org.jetbrains.dokka:versioning-plugin:1.9.20")
297+
classpath("org.jetbrains.dokka:versioning-plugin:2.0.0")
298298
}
299299
}
300300

301301
dependencies {
302-
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20")
302+
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:2.0.0")
303303
}
304304

305305
tasks.dokkaHtml {

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

+3-3
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.22"
11-
id("org.jetbrains.dokka") version "1.9.20"
10+
kotlin("jvm") version "2.1.0"
11+
id("org.jetbrains.dokka") version "2.0.0"
1212
}
1313

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

examples/gradle/dokka-customFormat-example/gradle/wrapper/gradle-wrapper.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
distributionBase=GRADLE_USER_HOME
66
distributionPath=wrapper/dists
7-
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
7+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip
88
networkTimeout=10000
99
zipStoreBase=GRADLE_USER_HOME
1010
zipStorePath=wrapper/dists

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

+2-2
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.22"
10-
id("org.jetbrains.dokka") version "1.9.20"
9+
kotlin("jvm") version "2.1.0"
10+
id("org.jetbrains.dokka") version "2.0.0"
1111
}
1212

1313
repositories {

examples/gradle/dokka-gradle-example/gradle/wrapper/gradle-wrapper.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
distributionBase=GRADLE_USER_HOME
66
distributionPath=wrapper/dists
7-
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
7+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip
88
networkTimeout=10000
99
zipStoreBase=GRADLE_USER_HOME
1010
zipStorePath=wrapper/dists

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
*/
44

55
plugins {
6-
kotlin("jvm") version "1.9.22"
7-
id("org.jetbrains.dokka") version "1.9.20"
6+
kotlin("jvm") version "2.1.0"
7+
id("org.jetbrains.dokka") version "2.0.0"
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.20")
18+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:2.0.0")
1919

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

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

examples/gradle/dokka-kotlinAsJava-example/gradle/wrapper/gradle-wrapper.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
distributionBase=GRADLE_USER_HOME
66
distributionPath=wrapper/dists
7-
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
7+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-bin.zip
88
networkTimeout=10000
99
zipStoreBase=GRADLE_USER_HOME
1010
zipStorePath=wrapper/dists

0 commit comments

Comments
 (0)