Skip to content

Commit 66fc242

Browse files
atyrin review
1 parent fb10fbd commit 66fc242

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

docs/topics/dokka-migration.md

+12-17
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Update the Dokka version to 2.0.0 in the `plugins {}` block of your project’s
4242

4343
```kotlin
4444
plugins {
45-
kotlin("jvm") version "1.9.25"
45+
kotlin("jvm") version "2.1.10"
4646
id("org.jetbrains.dokka") version "2.0.0"
4747
}
4848
```
@@ -134,7 +134,7 @@ dokka {
134134
includes.from("README.md")
135135
sourceLink {
136136
localDirectory.set(file("src/main/kotlin"))
137-
remoteUrl("https://example.com/src")
137+
remoteUrl.set(URI("https://example.com/src"))
138138
remoteLineSuffix.set("#L")
139139
}
140140
}
@@ -213,7 +213,7 @@ New configuration:
213213
includes.from("README.md")
214214
sourceLink {
215215
localDirectory.set(file("src/main/kotlin"))
216-
remoteUrl("https://github.com/your-repo")
216+
remoteUrl.set(URI("https://github.com/your-repo"))
217217
remoteLineSuffix.set("#L")
218218
}
219219
}
@@ -259,18 +259,13 @@ to define each link and aligning with Gradle DSL conventions.
259259
Previous configuration:
260260

261261
```kotlin
262-
dokka {
263-
this: DokkaExtension
264-
dokkaSourceSets.configureEach {
265-
this: DokkaSourceSetSpec
266-
externalDocumentationLinks {
267-
this: NamedDomainObjectContainerScope<DokkaExternalDocumentationLink> ->
268-
url = URL("https://example.com/docs/")
269-
packageListUrl = File("/path/to/package-list").toURI().toURL()
270-
}
271-
externalDocumentationLink {
272-
url = URL("https://example.com/docs/")
273-
packageListUrl = File("/path/to/package-list").toURI().toURL()
262+
tasks.dokkaHtml {
263+
dokkaSourceSets {
264+
configureEach {
265+
externalDocumentationLink {
266+
url = URL("https://example.com/docs/")
267+
packageListUrl = File("/path/to/package-list").toURI().toURL()
268+
}
274269
}
275270
}
276271
}
@@ -404,7 +399,7 @@ class in your `build.gradle.kts` file. The following example shows how to define
404399
// build.gradle.kts
405400

406401
plugins {
407-
id("org.jetbrains.dokka") version "2.0.0-Beta"
402+
id("org.jetbrains.dokka") version "2.0.0"
408403
}
409404

410405
val dokkaScripts = layout.projectDirectory.dir("dokka-scripts")
@@ -421,7 +416,7 @@ dokka {
421416
@OptIn(DokkaInternalApi::class)
422417
abstract class DokkaScriptsPluginParameters @Inject constructor(
423418
name: String
424-
) : DokkaPluginParametersBaseSpec(name, "ca.solostudios.dokkascript.plugin.DokkaScriptsPlugin") {
419+
) : DokkaPluginParametersBaseSpec(name, "example.dokkascript.plugin.DokkaScriptsPlugin") {
425420

426421
@get:InputFiles
427422
@get:PathSensitive(PathSensitivity.RELATIVE)

0 commit comments

Comments
 (0)