feat: create dokka convention plugin

Author: biplab1

build-logic/convention/build.gradle.kts

@@ -28,6 +28,7 @@ dependencies {
     compileOnly(libs.detekt.gradlePlugin)
     compileOnly(libs.ktlint.gradlePlugin)
     compileOnly(libs.spotless.gradle)
+    compileOnly(libs.dokka.gradlePlugin)
     implementation(libs.truth)
     compileOnly(libs.androidx.room.gradle.plugin)
     compileOnly(libs.firebase.crashlytics.gradlePlugin)
@@ -142,5 +143,11 @@ gradlePlugin {
             description = "Configures keystore management tasks for the project"
         }
 
+        // Dokka for documentation
+        register("dokkaConvention") {
+            id = "org.convention.dokka.plugin"
+            implementationClass = "org.convention.DokkaConventionPlugin"
+            description = "Configures Dokka for the project."
+        }
     }
 }

build-logic/convention/src/main/kotlin/CMPFeatureConventionPlugin.kt

@@ -24,6 +24,7 @@ class CMPFeatureConventionPlugin : Plugin<Project> {
                 apply("org.jetbrains.compose")
                 apply("org.convention.detekt.plugin")
                 apply("org.convention.spotless.plugin")
+                apply("org.convention.dokka.plugin")
             }
 
             dependencies {

build-logic/convention/src/main/kotlin/DokkaConventionPlugin.kt

@@ -0,0 +1,15 @@
+import org.convention.configureDokkaConvention
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+class DokkaConventionPlugin : Plugin<Project> {
+    override fun apply(target: Project) {
+        target.configureDokkaConvention()
+    }
+
+    private fun Project.applyPlugins() {
+        pluginManager.apply {
+            apply("org.jetbrains.dokka")
+        }
+    }
+}

build-logic/convention/src/main/kotlin/KMPLibraryConventionPlugin.kt

@@ -23,6 +23,7 @@ class KMPLibraryConventionPlugin: Plugin<Project> {
                 apply("org.convention.spotless.plugin")
                 apply("org.jetbrains.kotlin.plugin.serialization")
                 apply("org.jetbrains.kotlin.plugin.parcelize")
+                apply("org.convention.dokka.plugin")
             }
 
             configureKotlinMultiplatform()

build-logic/convention/src/main/kotlin/org/convention/Dokka.kt

@@ -0,0 +1,17 @@
+package org.convention
+
+import org.gradle.api.Project
+
+/**
+ * Configures the Dokka plugin with automatic moduleName generation based on the project hierarchy.
+ */
+internal fun Project.configureDokkaConvention() = dokkaGradle {
+    val defaultModuleName = project.path
+        .trimStart(':')
+        .replace(':', '-')
+        .ifBlank { project.name }
+
+    if (moduleName.orNull.isNullOrBlank()) {
+        moduleName.set(defaultModuleName)
+    }
+}

build-logic/convention/src/main/kotlin/org/convention/ProjectExtensions.kt

@@ -9,6 +9,7 @@ import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.getByType
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.plugin.KotlinHierarchyBuilder
+import org.jetbrains.dokka.gradle.DokkaTask
 
 /**
  * Get the `libs` version catalog.
@@ -36,4 +37,11 @@ inline fun Project.detektGradle(crossinline configure: DetektExtension.() -> Uni
 inline fun Project.spotlessGradle(crossinline configure: SpotlessExtension.() -> Unit) =
     extensions.configure<SpotlessExtension> {
         configure()
-    }
+    }
+
+/**
+ * Configures the `dokka` plugin with the [configure] lambda for all DokkaTasks.
+ */
+fun Project.dokkaGradle(configure: DokkaTask.() -> Unit) {
+    tasks.withType(DokkaTask::class.java).configureEach(configure)
+}

cmp-android/build.gradle.kts

@@ -20,7 +20,6 @@ plugins {
     alias(libs.plugins.aboutLibraries)
     alias(libs.plugins.keystore.management)
     id("com.google.devtools.ksp")
-    alias(libs.plugins.dokka)
 }
 
 val packageNameSpace: String = libs.versions.androidPackageNamespace.get()

cmp-desktop/build.gradle.kts

@@ -14,7 +14,6 @@ plugins {
     alias(libs.plugins.compose.compiler)
     alias(libs.plugins.jetbrainsCompose)
     alias(libs.plugins.kotlin.serialization)
-    alias(libs.plugins.dokka)
 }
 
 kotlin {

cmp-navigation/build.gradle.kts

@@ -12,7 +12,6 @@ plugins {
     alias(libs.plugins.kmp.library.convention)
     alias(libs.plugins.cmp.feature.convention)
     alias(libs.plugins.kmp.koin.convention)
-    alias(libs.plugins.dokka)
 }
 
 kotlin {

cmp-shared/build.gradle.kts

@@ -12,7 +12,6 @@ plugins {
     alias(libs.plugins.kmp.library.convention)
     alias(libs.plugins.cmp.feature.convention)
     alias(libs.plugins.kotlinCocoapods)
-    alias(libs.plugins.dokka)
 }
 
 kotlin {