Updated Dokka Gradle Plugin (#410)

* Updated Dokka Gradle Plugin
* Updated templates dir configuration
* Bump up DGP version
* Fixed sample sourcesets setup
* Updated external links setup
* Update gradle.properties

Co-authored-by: Oleg Yukhnevich <[email protected]>

* Fixed templates dir configuration

---------

Co-authored-by: Oleg Yukhnevich <[email protected]>

Author: fzhinkin

build-logic/src/main/kotlin/kotlinx/io/conventions/kotlinx-io-dokka.gradle.kts

@@ -1,33 +1,19 @@
 /*
- * Copyright 2017-2024 JetBrains s.r.o. and respective authors and developers.
+ * Copyright 2017-2025 JetBrains s.r.o. and respective authors and developers.
  * Use of this source code is governed by the Apache 2.0 license that can be found in the LICENCE file.
  */
 
-import org.jetbrains.dokka.gradle.*
-import java.net.URL
-
 plugins {
     id("org.jetbrains.dokka")
 }
 
-// shared configuration for all dokka tasks (both partial and multi-module)
-tasks.withType<AbstractDokkaTask>().configureEach {
-    pluginsMapConfiguration.set(
-        mapOf(
-            "org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${
-                rootDir.resolve("dokka-templates")
-            }" }"""
-        )
-    )
-}
-
-tasks.withType<DokkaTaskPartial>().configureEach {
+dokka {
     dokkaSourceSets.configureEach {
         includes.from("Module.md")
 
         sourceLink {
             localDirectory = rootDir
-            remoteUrl = URL("https://github.com/kotlin/kotlinx-io/tree/master")
+            remoteUrl("https://github.com/kotlin/kotlinx-io/tree/master")
             remoteLineSuffix = "#L"
         }
 
@@ -39,9 +25,10 @@ tasks.withType<DokkaTaskPartial>().configureEach {
 
         // as in kotlinx-io-multiplatform.gradle.kts:configureSourceSet
         val platform = name.dropLast(4)
-        samples.from(
-            "common/test/samples",
-            "$platform/test/samples"
-        )
+        samples.from("$platform/test/samples")
+
+    }
+    pluginsConfiguration.html {
+        templatesDir = rootDir.resolve("dokka-templates")
     }
 }

build.gradle.kts

@@ -34,6 +34,10 @@ dependencies {
     kover(project(":kotlinx-io-core"))
     kover(project(":kotlinx-io-bytestring"))
     kover(project(":kotlinx-io-okio"))
+
+    dokka(project(":kotlinx-io-bytestring"))
+    dokka(project(":kotlinx-io-core"))
+    dokka(project(":kotlinx-io-okio"))
 }
 
 kover {

gradle.properties

@@ -9,3 +9,5 @@ kotlin.code.style=official
 org.gradle.jvmargs=-Xmx4G
 nativeBenchmarksEnabled=true
 kotlin.mpp.applyDefaultHierarchyTemplate=false
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.nowarn=true

gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 kotlin = "2.1.0"
 java = "8"
 multi-release-toolchain = "17"
-dokka = "1.9.20"
+dokka = "2.0.0"
 kover = "0.8.3"
 bcv = "0.16.3"
 benchmark = "0.4.13"

integration/kotlinx-io-okio/build.gradle.kts

@@ -41,11 +41,11 @@ kotlin {
     }
 }
 
-tasks.withType(DokkaTaskPartial::class) {
+dokka {
     dokkaSourceSets.configureEach {
-        externalDocumentationLink {
-            url = URL("https://square.github.io/okio/3.x/okio/")
-            packageListUrl = URL("https://square.github.io/okio/3.x/okio/okio/package-list")
+        externalDocumentationLinks.register("okio") {
+            url("https://square.github.io/okio/3.x/okio/")
+            packageListUrl("https://square.github.io/okio/3.x/okio/okio/package-list")
         }
     }
 }