kdoc project to doc the released toolkit components. (#284)

* kdoc project to doc the released toolkit components.

* add dependencies on the dependencies of the released projects.

* Update kdoc/build.gradle.kts

Co-authored-by: Erick Lopez Solis <[email protected]>

---------

Co-authored-by: Soren Roth <[email protected]>
Co-authored-by: Erick Lopez Solis <[email protected]>

Author: 3 people

build.gradle.kts

@@ -23,4 +23,5 @@ plugins {
     alias(libs.plugins.kotlin.android) apply false
     alias(libs.plugins.gradle.secrets) apply false
     alias(libs.plugins.kotlin.serialization) apply false
+    alias(libs.plugins.dokka) apply false
 }

gradle/libs.versions.toml

@@ -8,6 +8,7 @@ androidxEspresso = "3.5.1"
 androidxLifecycle = "2.6.2"
 androidxTestExt = "1.1.5"
 compileSdk = "34"
+dokka = "1.9.10"
 junit = "4.13.2"
 kotlin = "1.9.21"
 minSdk = "26"
@@ -43,6 +44,7 @@ truth = { group = "com.google.truth", name = "truth", version.ref = "truth" }
 [plugins]
 android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
 android-library = { id = "com.android.library", version.ref = "androidGradlePlugin" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 gradle-secrets = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version = "2.0.1"}
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }

kdoc/build.gradle.kts

@@ -0,0 +1,107 @@
+/*
+ *
+ *  Copyright 2024 Esri
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */
+
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+    alias(libs.plugins.dokka)
+}
+
+val versionNumber: String by project
+val buildNumber: String by project
+val ignoreBuildNumber: String by project
+val artifactVersion: String = if (ignoreBuildNumber == "true") {
+    versionNumber
+} else {
+    "$versionNumber-$buildNumber"
+}
+
+// make this project get evaluated after all the other projects
+// so that we can be sure the logic to determine released components
+// below works
+rootProject.subprojects.filter {
+    it.name != project.name && it.name != "bom"
+}.forEach {
+    evaluationDependsOn(":${it.name}")
+}
+
+val releasedModules = project.rootProject.subprojects.filter {
+    it.plugins.findPlugin("artifact-deploy") != null
+}
+
+// determine the released toolkit components
+val releasedSourceSets = releasedModules.map { subproject ->
+    // add all the intended library projects as sourceSets below
+    File(rootDir, "toolkit/${subproject.name}/src/main/java").canonicalPath
+}
+
+tasks {
+    //./gradlew :documentation:dokkaHtml
+    // doc output will be under `documentation/build/dokka/html`.
+    dokkaHtml {
+        moduleName.set("arcgis-maps-kotlin-toolkit")
+        dokkaSourceSets {
+            configureEach {
+                perPackageOption {
+                    matchingRegex.set(".*internal.*")
+                    suppress.set(true)
+                }
+                
+                perPackageOption {
+                    reportUndocumented.set(true)
+                }
+                
+            }
+        }
+    }
+}
+
+android {
+    namespace = "com.arcgismaps.toolkit.doc"
+    compileSdk = libs.versions.compileSdk.get().toInt()
+    
+    defaultConfig {
+        minSdk = libs.versions.minSdk.get().toInt()
+        
+        consumerProguardFiles("consumer-rules.pro")
+    }
+
+    sourceSets {
+        named("main") {
+            java {
+                releasedSourceSets.forEach {
+                    srcDir(it)
+                }
+            }
+        }
+    }
+}
+
+dependencies {
+    project.afterEvaluate {
+       releasedModules.forEach { proj ->
+           proj.configurations.forEach { config ->
+               config.allDependencies.forEach {
+                   //add all dependencies as implementation dependencies, no need for api.
+                   project.dependencies.add("implementation", it)
+               }
+           }
+       }
+    }
+}
+

settings.gradle.kts

@@ -63,7 +63,7 @@ dependencyResolutionManagement {
             } else {
                 sdkVersionNumber
             }
-            version("mapsSdk", "$versionAndBuild")
+            version("mapsSdk", versionAndBuild)
             library("mapsSdk", "com.esri", "arcgis-maps-kotlin").versionRef("mapsSdk")
         }
     }
@@ -72,6 +72,7 @@ dependencyResolutionManagement {
 var includedProjects = projects.flatMap { listOf(":$it", ":$it-app") }.toTypedArray()
 include(*includedProjects)
 include(":bom")
+include(":kdoc")
 include(":composable-map")
 include(":indoors")
 include(":floor-filter-app")