dokka task added.

Author: syslogic

build.gradle.kts

@@ -6,6 +6,8 @@ plugins {
     alias(libs.plugins.kotlin.compose.compiler) apply false
     alias(libs.plugins.builtin.kotlin) apply false
     alias(libs.plugins.legacy.kapt) apply false
+    alias(libs.plugins.dokka.javadoc) apply false
+    alias(libs.plugins.dokka.html) apply false
 }
 
 tasks.register<Delete>("clean") {

compose/build.gradle.kts

@@ -1,5 +1,4 @@
 import com.android.build.api.dsl.LibraryExtension
-import org.gradle.kotlin.dsl.assign
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 // Module :library
@@ -8,6 +7,8 @@ plugins {
     alias(libs.plugins.kotlin.compose.compiler)
     alias(libs.plugins.builtin.kotlin)
     alias(libs.plugins.legacy.kapt)
+    alias(libs.plugins.dokka.html)
+    alias(libs.plugins.dokka.javadoc)
     id("maven-publish")
 }
 
@@ -22,6 +23,10 @@ kotlin {
     }
 }
 
+kapt {
+    generateStubs = true
+}
+
 composeCompiler {
     reportsDestination = layout.buildDirectory.dir("compose_compiler")
 }
@@ -55,7 +60,7 @@ configure<LibraryExtension> {
 
     buildTypes {
         debug {
-            // it breaks the data-binding, eg. when running ./gradlew :library:publishToMavenLocal
+            // it breaks the data-binding, e.g. when running ./gradlew :library:publishToMavenLocal
             enableAndroidTestCoverage = false
             isMinifyEnabled = false
         }
@@ -106,6 +111,104 @@ dependencies {
 
     /* Composable Preview */
     debugImplementation(libs.bundles.androidx.compose.tooling)
+
+    dokkaPlugin(libs.dokka.android.documentation.plugin)
+}
+
+// Dokka generation
+dokka {
+
+    dokkaSourceSets.create("main") {
+
+        val sdkComponents = androidComponents::sdkComponents.get()
+        val sdkDirectory: Directory? = sdkComponents.sdkDirectory.get()
+        val compileSdk = project.extensions.getByType<LibraryExtension>().compileSdk
+
+        sourceRoots.from(
+            files(File("${sdkDirectory}/platforms/${compileSdk}/android.jar")),
+            "${projectDir.absolutePath}/src/main/java"
+        )
+
+        sourceLink {
+            localDirectory.set(file("src/main/java"))
+            remoteUrl("https://github.com/syslogic/androidx-colorpicker/tree/master/compose/src/main/java")
+            remoteLineSuffix.set("#L")
+        }
+    }
+
+    dokkaSourceSets.configureEach {
+
+        enableJdkDocumentationLink.set(true)
+        enableKotlinStdLibDocumentationLink.set(true)
+        enableAndroidDocumentationLink.set(true)
+        jdkVersion.set(17)
+
+        dokkaPublications.javadoc {
+            moduleName.set(project.name)
+            moduleVersion.set(project.version.toString())
+            outputDirectory.set(layout.buildDirectory.dir("dokka/javadoc"))
+        }
+        dokkaPublications.html {
+            moduleName.set(project.name)
+            moduleVersion.set(project.version.toString())
+            outputDirectory.set(layout.buildDirectory.dir("dokka/html"))
+        }
+    }
+}
+
+val dokkaGenerateJavadocJar by tasks.registering(Jar::class) {
+    group = "dokka"
+    dependsOn(tasks.dokkaGeneratePublicationJavadoc)
+    from(tasks.dokkaGeneratePublicationJavadoc.flatMap { it.outputDirectory })
+    archiveClassifier.set("javadoc")
+    description = "Assembles a JAR containing the Javadoc-style documentation generated by Dokka."
+}
+
+val dokkaGenerateHtmlJar by tasks.registering(Jar::class) {
+    group = "dokka"
+    dependsOn(tasks.dokkaGeneratePublicationHtml)
+    from(tasks.dokkaGeneratePublicationHtml.flatMap { it.outputDirectory })
+    archiveClassifier.set("html-docs")
+    description = "Assembles a JAR containing the HTML documentation generated by Dokka."
+}
+
+val dokkaCleanJavadoc by tasks.registering(Delete::class) {
+    group = "dokka"
+    delete = setOf(project.file("build/dokka/javadoc"))
+    description = "It removes the documentation generated by Dokka."
+}
+
+val dokkaCleanHtml by tasks.registering(Delete::class) {
+    group = "dokka"
+    delete = setOf(project.file("build/dokka/html"))
+    description = "It removes the documentation generated by Dokka."
+}
+
+// tasks.dokkaGeneratePublicationJavadoc.dependsOn(dokkaCleanJavadoc)
+// tasks.dokkaGeneratePublicationHtml.dependsOn(dokkaCleanHtml)
+
+val dokkaClean by tasks.registering {
+    group = "dokka"
+    dependsOn(dokkaCleanJavadoc, dokkaCleanHtml)
+}
+
+val sourcesJar by tasks.registering(Jar::class) {
+    archiveClassifier.set("sources")
+    from(project.file("src/main/java"))
+}
+
+// Gradle 9.1 deprecation fix
+configurations {
+    @Suppress("UnstableApiUsage")
+    consumable("jars") {
+        outgoing.artifact(dokkaGenerateJavadocJar)
+        outgoing.artifact(sourcesJar)
+    }
+}
+
+tasks.named("assemble") {
+    dependsOn(dokkaGenerateJavadocJar)
+    dependsOn(sourcesJar)
 }
 
 group   = "io.syslogic"

compose/src/main/java/io/syslogic/colorpicker/compose/AlphaPainter.kt

@@ -13,7 +13,6 @@ import androidx.compose.ui.graphics.painter.Painter
 
 /**
  * Jetpack Compose Alpha Painter
- *
  * @author Martin Zeitler
  */
 class AlphaPainter(intrinsicSize: Size) : BasePainter(intrinsicSize) {

compose/src/main/java/io/syslogic/colorpicker/compose/BasePainter.kt

@@ -15,7 +15,6 @@ import kotlin.properties.Delegates
 
 /**
  * Jetpack Compose Base Painter
- *
  * @author Martin Zeitler
  */
 abstract class BasePainter(override val intrinsicSize: Size) : Painter() {

compose/src/main/java/io/syslogic/colorpicker/compose/ColorPainter.kt

@@ -10,7 +10,6 @@ import androidx.compose.ui.graphics.painter.Painter
 
 /**
  * Jetpack Compose Color Painter
- *
  * @author Martin Zeitler
  */
 class ColorPainter(intrinsicSize: Size) : BasePainter(intrinsicSize) {

compose/src/main/java/io/syslogic/colorpicker/compose/ColorPickerDialogPreview.kt

@@ -9,7 +9,6 @@ import androidx.compose.ui.tooling.preview.Preview
 
 /**
  * ColorPickerDialog Preview
- *
  * @author Martin Zeitler
  */
 @Preview(

compose/src/main/java/io/syslogic/colorpicker/compose/ColorPickerPreview.kt

@@ -7,7 +7,6 @@ import androidx.compose.ui.tooling.preview.Preview
 
 /**
  * ColorPicker Preview
- *
  * @author Martin Zeitler
  */
 @Preview(

compose/src/main/java/io/syslogic/colorpicker/compose/HuePainter.kt

@@ -13,7 +13,6 @@ import androidx.compose.ui.graphics.painter.Painter
 
 /**
  * Jetpack Compose Hue Painter
- *
  * @author Martin Zeitler
  */
 class HuePainter(intrinsicSize: Size) : BasePainter(intrinsicSize) {

compose/src/main/java/io/syslogic/colorpicker/compose/LayoutId.kt

@@ -2,7 +2,6 @@ package io.syslogic.colorpicker.compose
 
 /**
  * Jetpack Compose Layout Ids
- *
  * @author Martin Zeitler
  */
 enum class LayoutId {

compose/src/main/java/io/syslogic/colorpicker/compose/OnColorChangedListener.kt

@@ -1,7 +1,7 @@
 package io.syslogic.colorpicker.compose
 
 /**
- * OnColorChangedListener.
+ * OnColorChangedListener
  * @author Martin Zeitler
  */
 interface OnColorChangedListener {