dokka tasks improved.

Author: syslogic

gradle/libs.versions.toml

@@ -24,12 +24,12 @@ kotlinx-io = "0.8.2"
 ktor = "3.3.3"
 mavenPublish = "0.35.0"
 mockito-android = "5.20.0"
-mockk = "1.14.6"
+mockk = "1.14.7"
 multipaz = "0.94.0" # 0.95.0
 nimbus-sdk = "11.30.1"
 play-services-identity-credentials = "16.0.0-alpha08"
 robolectric = "4.16"
-sonarqube = "7.1.0.6387"
+sonarqube = "7.2.0.6526"
 test-core = "1.7.0"
 test-rules = "1.7.0"
 test-runner = "1.7.0"

gradle/wrapper/gradle-wrapper.properties

@@ -16,7 +16,7 @@
 
 #Thu Sep 12 17:12:58 EEST 2024
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

wallet-core/build.gradle.kts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import com.android.build.gradle.internal.tasks.factory.dependsOn
 import com.github.jk1.license.filter.DependencyFilter
 import com.github.jk1.license.filter.ExcludeTransitiveDependenciesFilter
 import com.github.jk1.license.filter.LicenseBundleNormalizer
@@ -169,7 +170,6 @@ dependencies {
 }
 
 // Dependency check
-
 dependencyCheck {
     formats = listOf("XML", "HTML")
     nvd.apiKey = System.getenv("NVD_API_KEY") ?: properties["nvdApiKey"]?.toString() ?: ""
@@ -180,34 +180,53 @@ dependencyCheck {
 // Dokka generation
 dokka {
     dokkaSourceSets.configureEach {
+        dokkaPublications.javadoc {
+            outputDirectory.set(rootProject.file("docs/javadoc"))
+        }
         dokkaPublications.html {
-            outputDirectory.set(rootProject.file("docs"))
+            outputDirectory.set(rootProject.file("docs/html"))
         }
         externalDocumentationLinks.register("android") {
             url("https://developer.android.com/reference")
             packageListUrl("https://developer.android.com/reference/kotlin/package-list")
         }
-        externalDocumentationLinks.register("java") {
-            url("https://docs.oracle.com/en/java/javase/17/docs/api/")
-            packageListUrl("https://docs.oracle.com/en/java/javase/17/docs/api/allpackages-index.html")
-        }
     }
 }
 
-val dokkaHtmlJar by tasks.registering(Jar::class) {
-    group = "documentation"
+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 dokkaJavadocJar by tasks.registering(Jar::class) {
-    group = "documentation"
-    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 dokkaCleanJavadoc by tasks.registering(Delete::class) {
+    group = "dokka"
+    delete = setOf(rootProject.file("docs/javadoc"))
+    description = "It removes the documentation generated by Dokka."
+}
+
+val dokkaCleanHtml by tasks.registering(Delete::class) {
+    group = "dokka"
+    delete = setOf(rootProject.file("docs/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)
 }
 
 // Third-party licenses report
@@ -236,8 +255,8 @@ tasks.generateLicenseReport.configure {
 // Build documentation and license report
 tasks.register<Task>("buildDocumentation") {
     group = "documentation"
-    dependsOn("dokkaGfm", "generateLicenseReport")
-    description = "Aggregates all documentation tasks (Dokka GFM, License Report)."
+    dependsOn("dokkaGenerate", "generateLicenseReport")
+    description = "Aggregates all documentation tasks (Dokka, License Report)."
 }
 tasks.assemble.configure {
     finalizedBy("buildDocumentation")