MW-213 Discover and implement kotlin docs and generate documentation

build-logic/convention/build.gradle.kts

@@ -1,5 +1,6 @@
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
+
 plugins {
     `kotlin-dsl`
 }
@@ -29,6 +30,7 @@ dependencies {
     compileOnly(libs.ktlint.gradlePlugin)
     compileOnly(libs.spotless.gradle)
     implementation(libs.truth)
+    compileOnly(libs.dokka.gradle.plugin)
 }
 
 tasks {

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

@@ -2,6 +2,7 @@
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.dependencies
+import org.mifospay.configureFeatureDocumentation
 import org.mifospay.libs
 
 class CMPFeatureConventionPlugin : Plugin<Project> {
@@ -12,7 +13,9 @@ class CMPFeatureConventionPlugin : Plugin<Project> {
                 apply("mifospay.kmp.koin")
                 apply("org.jetbrains.kotlin.plugin.compose")
                 apply("org.jetbrains.compose")
+                apply("org.jetbrains.dokka")
             }
+            configureFeatureDocumentation()
 
             dependencies {
                 add("commonMainImplementation", project(":core:ui"))

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

@@ -4,6 +4,7 @@ import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.dependencies
+import org.mifospay.configureFeatureDocumentation
 import org.mifospay.configureFlavors
 import org.mifospay.configureKotlinAndroid
 import org.mifospay.configureKotlinMultiplatform
@@ -18,8 +19,9 @@ class KMPLibraryConventionPlugin: Plugin<Project> {
                 apply("mifospay.kmp.koin")
                 apply("mifos.detekt.plugin")
                 apply("mifos.spotless.plugin")
+                apply("org.jetbrains.dokka")
             }
-
+            configureFeatureDocumentation()
             configureKotlinMultiplatform()
 
             extensions.configure<LibraryExtension> {

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

@@ -0,0 +1,26 @@
+package org.mifospay
+
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.withType
+
+/**
+ * Configures Dokka documentation settings for a feature module.
+ * This extension function replaces the FeatureLibraryPlugin class by directly
+ * applying the same configuration to the target Project.
+ */
+// Add this in a shared convention plugin or utilities script
+fun Project.configureFeatureDocumentation() {
+    plugins.withId("org.jetbrains.dokka") {
+        tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
+            outputDirectory.set(layout.buildDirectory.dir("dokka"))
+            moduleName.set(project.name)
+
+            // Add KMP-specific configuration only for multiplatform modules
+            if (pluginManager.hasPlugin("org.jetbrains.kotlin.multiplatform")) {
+                dokkaSourceSets.configureEach {
+                   // includes.from("README.md")  // Include KMP-specific docs
+                }
+            }
+        }
+    }
+}

build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
+
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 buildscript {
     dependencies {
@@ -33,6 +35,7 @@ plugins {
     alias(libs.plugins.kotlinMultiplatform) apply false
     alias(libs.plugins.wire) apply false
     alias(libs.plugins.ktorfit) apply false
+    alias(libs.plugins.dokka) apply false
 }
 
 object DynamicVersion {
@@ -57,7 +60,6 @@ tasks.register("printModulePaths") {
         }
     }
 }
-
 // Configuration for CMP module dependency graph
 moduleGraphAssert {
     configurations += setOf("commonMainImplementation", "commonMainApi")
@@ -66,4 +68,13 @@ moduleGraphAssert {
     configurations += setOf("jsMainImplementation", "jsMainApi")
     configurations += setOf("nativeMainImplementation", "nativeMainApi")
     configurations += setOf("wasmJsMainImplementation", "wasmJsMainApi")
-}
+}
+
+// root build.gradle.kts
+tasks.register<DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
+    outputDirectory.set(buildDir.resolve("docs"))
+
+    // Automatically collect all dokkaHtml tasks from subprojects
+    addChildTasks(subprojects, "dokkaHtml")
+}
+

feature/accounts/build.gradle.kts

@@ -27,4 +27,4 @@ kotlin {
             implementation(libs.kotlinx.serialization.json)
         }
     }
-}
+}

feature/accounts/src/commonMain/kotlin/org/mifospay/feature/accounts/AccountViewModel.kt

@@ -34,7 +34,6 @@ import org.mifospay.feature.accounts.AccountAction.Internal.DeleteBeneficiary
 import org.mifospay.feature.accounts.AccountEvent.OnAddEditSavingsAccount
 import org.mifospay.feature.accounts.beneficiary.BeneficiaryAddEditType
 import org.mifospay.feature.accounts.savingsaccount.SavingsAddEditType
-
 @OptIn(ExperimentalCoroutinesApi::class)
 class AccountViewModel(
     private val userRepository: UserPreferencesRepository,
@@ -51,6 +50,9 @@ class AccountViewModel(
         )
     },
 ) {
+    /**
+     * Exposes the account and beneficiary list as a [StateFlow] of [AccountState.ViewState].
+     */
     val accountState = repository.getAccountAndBeneficiaryList(state.clientId)
         .mapLatest {
             when (it) {
@@ -67,6 +69,9 @@ class AccountViewModel(
             initialValue = AccountState.ViewState.Loading,
         )
 
+    /**
+     * Handles [AccountAction] and triggers corresponding [AccountEvent] or state updates.
+     */
     override fun handleAction(action: AccountAction) {
         when (action) {
             is AccountAction.CreateSavingsAccount -> {
@@ -124,6 +129,9 @@ class AccountViewModel(
         }
     }
 
+    /**
+     * Handles updating the default account in [userRepository].
+     */
     private fun handleSetDefaultAccount(action: AccountAction.SetDefaultAccount) {
         viewModelScope.launch {
             userRepository.updateDefaultAccount(
@@ -138,6 +146,9 @@ class AccountViewModel(
         sendEvent(AccountEvent.ShowToast("Default account updated"))
     }
 
+    /**
+     * Sends a delete request for the given beneficiary ID and shows a loading dialog.
+     */
     private fun handleDeleteBeneficiary(action: DeleteBeneficiary) {
         mutableStateFlow.update { it.copy(dialogState = AccountState.DialogState.Loading) }
 
@@ -148,6 +159,9 @@ class AccountViewModel(
         }
     }
 
+    /**
+     * Handles the result of deleting a beneficiary and updates dialog state accordingly.
+     */
     private fun handleBeneficiaryDeleteResult(action: BeneficiaryDeleteResultReceived) {
         when (action.result) {
             is DataState.Success -> {
@@ -175,36 +189,52 @@ class AccountViewModel(
     }
 }
 
+/**
+ * Represents the state of the account screen.
+ */
 data class AccountState(
     val clientId: Long,
     val defaultAccountId: Long? = null,
     val dialogState: DialogState? = null,
 ) {
+    /**
+     * Defines various dialog UI states.
+     */
     sealed interface DialogState {
+        /** Represents a loading dialog. */
         data object Loading : DialogState
+
+        /** Represents an error dialog with a message. */
         data class Error(val message: String) : DialogState
+
+        /** Dialog shown before deleting a beneficiary. */
         data class DeleteBeneficiary(
             val title: StringResource,
             val message: StringResource,
             val onConfirm: () -> Unit,
         ) : DialogState
     }
 
+    /**
+     * UI state representing the screen's visual content.
+     */
     sealed interface ViewState {
         val hasFab: Boolean
-
         val isPullToRefreshEnabled: Boolean
 
+        /** Loading view state. */
         data object Loading : ViewState {
             override val hasFab: Boolean get() = false
             override val isPullToRefreshEnabled: Boolean get() = false
         }
 
+        /** Error view state with a message. */
         data class Error(val message: String) : ViewState {
             override val hasFab: Boolean get() = false
             override val isPullToRefreshEnabled: Boolean get() = false
         }
 
+        /** Content view state with account and beneficiary info. */
         data class Content(
             val accounts: List<Account>,
             val beneficiaries: List<Beneficiary>,
@@ -215,26 +245,32 @@ data class AccountState(
     }
 }
 
+/**
+ * Events that can be sent by [AccountViewModel] to update the UI.
+ */
 sealed interface AccountEvent {
     data class OnAddEditSavingsAccount(val type: SavingsAddEditType) : AccountEvent
     data class OnNavigateToAccountDetail(val accountId: Long) : AccountEvent
     data class OnAddOrEditTPTBeneficiary(val type: BeneficiaryAddEditType) : AccountEvent
-
     data class ShowToast(val message: String) : AccountEvent
 }
 
+/**
+ * Actions that can be triggered from the UI to be handled by [AccountViewModel].
+ */
 sealed interface AccountAction {
     data object AddTPTBeneficiary : AccountAction
     data class EditBeneficiary(val beneficiary: Beneficiary) : AccountAction
     data class DeleteBeneficiary(val beneficiaryId: Long) : AccountAction
-
     data object CreateSavingsAccount : AccountAction
     data class EditSavingsAccount(val accountId: Long) : AccountAction
     data class ViewAccountDetails(val accountId: Long) : AccountAction
     data class SetDefaultAccount(val accountId: Long, val accountNo: String) : AccountAction
-
     data object DismissDialog : AccountAction
 
+    /**
+     * Internal-only actions used within the view model.
+     */
     sealed interface Internal : AccountAction {
         data class DeleteBeneficiary(val beneficiaryId: Long) : Internal
         data class BeneficiaryDeleteResultReceived(val result: DataState<String>) : Internal

feature/auth/build.gradle.kts

@@ -45,4 +45,5 @@ kotlin {
             implementation(libs.play.services.auth)
         }
     }
-}
+}
+