updated dokka to v2

Author: DatL4g

.github/workflows/publish.yml

@@ -69,15 +69,15 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Generate documentation
-        run: ./gradlew dokkaHtmlMultiModule
+        run: ./gradlew dokkaGenerate
       - name: Uploading build folder
         uses: actions/upload-artifact@v4
         with:
           name: artefact
-          path: build/dokka/htmlMultiModule
+          path: build/dokka/html
       - name: Deploy API documentation to Github Pages
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           branch: gh-pages
-          folder: build/dokka/htmlMultiModule
+          folder: build/dokka/html
           target-folder: docs

build.gradle.kts

@@ -2,9 +2,6 @@ import org.apache.tools.ant.taskdefs.condition.Os
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.gradle.api.tasks.testing.logging.TestLogEvent
 import org.jetbrains.dokka.DokkaConfiguration
-import org.jetbrains.dokka.base.DokkaBase
-import org.jetbrains.dokka.base.DokkaBaseConfiguration
-import org.jetbrains.dokka.gradle.AbstractDokkaTask
 import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import java.net.URL
 import java.io.InputStream
@@ -20,16 +17,11 @@ plugins {
     alias(libs.plugins.kotlinter) apply false
     alias(libs.plugins.kotlinx.binarycompatibilityvalidator)
     alias(libs.plugins.dokka)
+    alias(libs.plugins.publish) apply false
     id("base")
     id("testOptionsConvention")
 }
 
-buildscript {
-    dependencies {
-        classpath(libs.dokka.base)
-    }
-}
-
 val compileSdkVersion by extra(36)
 val targetSdkVersion by extra(36)
 val minSdkVersion by extra(23)
@@ -54,59 +46,40 @@ tasks {
 }
 
 private val dokkaCopyrightMessage = "© 2024 GitLive Ltd."
-private val dokkaHomepageUrl = "https://github.com/GitLiveApp/firebase-kotlin-sdk"
+private val dokkaHomepageUrl = "https://github.com/DatL4g/firebase-kotlin-sdk"
 
-tasks.withType<AbstractDokkaTask>().configureEach {
+dokka {
     val version = project.property("firebase-app.version") as String
     moduleVersion.set(version)
     moduleName.set("Firebase Kotlin SDK")
 
-    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
-        customAssets = listOf(file("documentation/gitlive-logo.png"), file("documentation/homepage.svg"))
-        customStyleSheets = listOf(file("documentation/logo-styles.css"))
-        footerMessage = dokkaCopyrightMessage
-        homepageLink = dokkaHomepageUrl
+    pluginsConfiguration.html {
+        customAssets.from("documentation/gitlive-logo.png", "documentation/homepage.svg")
+        customStyleSheets.from("documentation/logo-styles.css")
+        footerMessage.set(dokkaCopyrightMessage)
+        homepageLink.set(dokkaHomepageUrl)
     }
 }
 
+dependencies {
+    dokka(project(":firebase-analytics"))
+    dokka(project(":firebase-app"))
+    dokka(project(":firebase-auth"))
+    dokka(project(":firebase-config"))
+    dokka(project(":firebase-crashlytics"))
+    dokka(project(":firebase-database"))
+    dokka(project(":firebase-firestore"))
+    dokka(project(":firebase-functions"))
+    dokka(project(":firebase-installations"))
+    dokka(project(":firebase-messaging"))
+    dokka(project(":firebase-perf"))
+    dokka(project(":firebase-storage"))
+}
+
 subprojects {
 
     group = "dev.gitlive"
 
-    val nonDocumentationList = listOf("test-utils", "firebase-common", "firebase-common-internal")
-    val skipDocumentation = nonDocumentationList.contains(project.name)
-    if (!skipDocumentation) {
-        apply(plugin = "org.jetbrains.dokka")
-    }
-
-    this.tasks.withType<DokkaTaskPartial>().configureEach {
-        pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
-            footerMessage = dokkaCopyrightMessage
-            separateInheritedMembers = false
-            homepageLink = dokkaHomepageUrl
-        }
-        dokkaSourceSets {
-            configureEach {
-                documentedVisibilities.set(setOf(DokkaConfiguration.Visibility.PUBLIC))
-                includes.setFrom("documentation.md")
-
-                sourceLink {
-                    localDirectory.set(projectDir.resolve("src"))
-                    remoteUrl.set(URL("$dokkaHomepageUrl/tree/master/${project.name}/src"))
-                }
-            }
-            if (this.names.contains("jsMain")) {
-                named("jsMain") {
-                    perPackageOption {
-                        // External files for JS should not be documented since they will not be available
-                        matchingRegex.set(".*.externals.*")
-                        suppress.set(true)
-                    }
-                }
-            }
-        }
-    }
-
     apply(plugin = "com.adarshr.test-logger")
     apply(plugin = "org.jmailen.kotlinter")
 

firebase-analytics/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -13,9 +14,31 @@ plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val minSdkVersion: Int by project
     val compileSdkVersion: Int by project

firebase-app/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -13,9 +14,31 @@ plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val minSdkVersion: Int by project
     val compileSdkVersion: Int by project

firebase-auth/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -15,9 +16,31 @@ plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val compileSdkVersion: Int by project
 

firebase-config/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -13,9 +14,31 @@ plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val minSdkVersion: Int by project
     val compileSdkVersion: Int by project

firebase-crashlytics/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -13,9 +14,31 @@ plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val minSdkVersion: Int by project
     val compileSdkVersion: Int by project

firebase-database/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -14,9 +15,31 @@ plugins {
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
     alias(libs.plugins.kotlinx.serialization)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val minSdkVersion: Int by project
     val compileSdkVersion: Int by project

firebase-firestore/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
@@ -14,9 +15,31 @@ plugins {
     alias(libs.plugins.native.cocoapods)
     alias(libs.plugins.multiplatform)
     alias(libs.plugins.kotlinx.serialization)
+    alias(libs.plugins.dokka)
     id("testOptionsConvention")
 }
 
+dokka {
+    dokkaSourceSets {
+        configureEach {
+            documentedVisibilities.set(setOf(VisibilityModifier.Public))
+            includes.setFrom("documentation.md")
+
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl("https://github.com/DatL4g/firebase-kotlin-sdk/tree/master/${project.name}/src")
+            }
+            if (this.name == "jsMain") {
+                perPackageOption {
+                    // External files for JS should not be documented since they will not be available
+                    matchingRegex.set(".*.externals.*")
+                    suppress.set(true)
+                }
+            }
+        }
+    }
+}
+
 android {
     val minSdkVersion: Int by project
     val compileSdkVersion: Int by project