Upgrade Dokka (make things build again)

Author: pdvrieze

build.gradle.kts

@@ -20,6 +20,7 @@
 
 import org.gradle.plugins.ide.idea.model.IdeaLanguageLevel
 import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
+import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension
 import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin
 import org.jetbrains.kotlin.gradle.targets.js.npm.tasks.KotlinNpmInstallTask
@@ -105,5 +106,14 @@ idea {
     }
 }
 
-tasks.withType<DokkaMultiModuleTask>().configureEach {
+dependencies {
+    dokka(projects.core)
+    dokka(projects.coreJdk)
+    dokka(projects.coreAndroid)
+    dokka(projects.serialization)
+    dokka(projects.serialutil)
+}
+
+tasks.dokkaHtml {
+    val x: DokkaTask? = this
 }

gradle.properties

@@ -26,3 +26,5 @@ xmlutil_versiondesc=
 kotlin.code.style=official
 native.deploy=
 xmlutil.wasmEnabled=false
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers
+#org.jetbrains.dokka.experimental.tryK2=true

gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 apiVersion = "1.8"
 binaryValidator = "0.16.3"
 dateTime = "0.6.1"
-dokka = "1.9.20"
+dokka = "2.0.0"
 javaVersion = "8"
 jmh = "0.7.2"
 jmh-core = "1.37"

project-plugins/src/main/kotlin/net/devrieze/gradle/ext/dokka.kt

@@ -25,7 +25,13 @@ import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.assign
 import org.gradle.kotlin.dsl.withType
 import org.jetbrains.dokka.gradle.AbstractDokkaLeafTask
+import org.jetbrains.dokka.gradle.DokkaExtension
+import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.dokka.gradle.GradleDokkaSourceSetBuilder
+import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
+import org.jetbrains.dokka.gradle.tasks.DokkaGenerateModuleTask
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
 import java.net.URI
 import java.net.URL
 
@@ -35,18 +41,27 @@ fun Project.configureDokka(
     dokkaOverrideTarget: Provider<String?>
 ) {
     logger.lifecycle("Configuring dokka for project($name)")
+    tasks.configureEach {
+        if (name.contains("dokka", ignoreCase = true)) {
+            logger.lifecycle("Dokka task: ${name} (${this.javaClass.simpleName})")
+        }
+    }
     tasks.withType<AbstractDokkaLeafTask>().configureEach {
-        if (this is AbstractDokkaLeafTask) {
-            logger.info("Configuring dokka task: ${this.name}")
-            moduleName.convention(myModuleName)
-            moduleVersion.convention(myModuleVersion)
+        logger.lifecycle("Configuring dokka task: ${name} (${this.javaClass.simpleName})")
+        moduleName.convention(myModuleName)
+        moduleVersion.convention(myModuleVersion)
 
-            dokkaSourceSets.configureEach {
-                this@configureDokka.configureDokkaSourceSet(this, dokkaOverrideTarget.getOrNull())
-            }
+        dokkaSourceSets.configureEach {
+            this@configureDokka.configureDokkaSourceSet(this, dokkaOverrideTarget.getOrNull())
+        }
+    }
+    extensions.configure<DokkaExtension>("dokka") {
+        logger.lifecycle("Configuring dokka task: ${name} (${this.javaClass.simpleName})")
+        moduleName.convention(myModuleName)
+        moduleVersion.convention(myModuleVersion)
 
-        } else if ("dokka" in name.lowercase()) {
-            logger.error("Non-configured dokka task: ${project.name}:${name} : ${this.javaClass.name}")
+        dokkaSourceSets.configureEach {
+            this@configureDokka.configureDokkaSourceSet(this, dokkaOverrideTarget.getOrNull())
         }
     }
 }
@@ -123,3 +138,75 @@ private fun Project.configureDokkaSourceSet(
         logger.warn("Sourceset ${project.name}:${sourceSet.name} suppressed")
     }
 }
+
+private fun Project.configureDokkaSourceSet(
+    sourceSet: DokkaSourceSetSpec,
+    dokkaOverrideTarget: String?
+) {
+    if (!sourceSet.suppress.get()) {
+        logger.info("Configuring dokkaSourceSet:${project.name}:${sourceSet.name}")
+        with(sourceSet) {
+            if (name.startsWith("android")) {
+                enableAndroidDocumentationLink = true
+                enableJdkDocumentationLink = false
+            } else {
+                enableAndroidDocumentationLink = false
+                enableJdkDocumentationLink = true
+            }
+            displayName.set(
+                dokkaOverrideTarget ?: when (val dn = displayName.get()?.lowercase()) {
+                    "jdk" -> "JVM"
+                    "jvm",
+                    "javashared",
+                    "commonjvm",
+                    "jvmcommon" -> "JVM"
+                    "android" -> "Android"
+                    "common" -> "Common"
+                    "js" -> "JS"
+                    "native" -> "Native"
+                    "commondom" -> "Native"
+                    "wasmcommon" -> "Wasm"
+                    else -> dn
+                }
+            )
+            logger.lifecycle("Configuring dokka on sourceSet: :${project.name}:$name = ${displayName.orNull}")
+
+            documentedVisibilities = setOf(VisibilityModifier.Public, VisibilityModifier.Protected)
+
+            skipEmptyPackages = true
+            skipDeprecated = true
+
+            for (sourceRoot in sourceSet.sourceRoots) {
+                val relativeRoot = sourceRoot.relativeTo(rootProject.projectDir)
+                logger.lifecycle("Adding source link for root: $relativeRoot")
+                sourceLink {
+                    localDirectory = sourceRoot
+                    val relURI = relativeRoot.toURI()
+                    val absUrl = URI.create("https://github.com/pdvrieze/xmlutil/tree/master/").resolve(relURI)
+                    remoteUrl = absUrl
+                }
+            }
+
+            externalDocumentationLinks.apply {
+                url("https://kotlinlang.org/api/kotlinx.serialization/")
+            }
+
+            perPackageOption {
+                matchingRegex.set(".*\\.(impl|internal)(|\\..*)")
+                suppress.set(true)
+            }
+            logger.lifecycle("Dokka source set: '$name'")
+            if ("Main" in name) {
+                val readme = project.file(project.relativePath("src/README.md"))
+                if (readme.exists() && readme.canRead()) {
+                    includes.from(listOf(readme))
+                    logger.lifecycle("Adding $readme to sourceSet :${project.name}:${name}(${displayName.orNull})")
+                } else {
+                    logger.warn("Missing $readme for project ${project.name}")
+                }
+            }
+        }
+    } else {
+        logger.warn("Sourceset ${project.name}:${sourceSet.name} suppressed")
+    }
+}

project-plugins/src/main/kotlin/net/devrieze/gradle/ext/publishing.kt

@@ -43,7 +43,7 @@ fun Project.doPublish(
 
     val javadocJarTask = tasks.create<Jar>("javadocJar") {
         archiveClassifier.set("javadoc")
-        from(tasks.named("dokkaHtml"))
+        from(tasks.named("dokkaGenerateModuleHtml"))
     }
 
     configure<PublishingExtension> {