MW-213 Discover and implement kotlin docs and generate documentation

.run/mifospay-ios.run.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="mifospay-ios" type="KmmRunConfiguration" factoryName="iOS Application" CONFIG_VERSION="1" XCODE_PROJECT="$PROJECT_DIR$/mifospay-ios/iosApp.xcodeproj">
+  <configuration default="false" name="mifospay-ios" type="KmmRunConfiguration" factoryName="iOS Application" CONFIG_VERSION="1" XCODE_PROJECT="$PROJECT_DIR$/mifospay-ios/iosApp.xcodeproj" XCODE_CONFIGURATION="Debug" XCODE_SCHEME="iosApp">
     <method v="2">
       <option name="com.jetbrains.kmm.ios.BuildIOSAppTask" enabled="true" />
     </method>

build.gradle.kts

@@ -33,6 +33,7 @@ plugins {
     alias(libs.plugins.kotlinMultiplatform) apply false
     alias(libs.plugins.wire) apply false
     alias(libs.plugins.ktorfit) apply false
+    alias(libs.plugins.dokka)
 }
 
 object DynamicVersion {

feature/accounts/build.gradle.kts

@@ -10,6 +10,7 @@
 plugins {
     alias(libs.plugins.mifospay.cmp.feature)
     alias(libs.plugins.kotlin.parcelize)
+    alias(libs.plugins.dokka)
 }
 
 android {
@@ -27,4 +28,23 @@ kotlin {
             implementation(libs.kotlinx.serialization.json)
         }
     }
+}
+// Configure Dokka
+tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
+    // Output format (HTML by default)
+    outputDirectory.set(layout.buildDirectory.dir("dokka"))
+
+    // Module name in documentation
+    moduleName.set("feature")
+
+    // Documentation format
+    dokkaSourceSets {
+        configureEach {
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl.set(uri("https://github.com/openMF/mobile-wallet.git").toURL())
+                remoteLineSuffix.set("#L")
+            }
+        }
+    }
 }

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

@@ -11,6 +11,7 @@ plugins {
     alias(libs.plugins.mifospay.cmp.feature)
     alias(libs.plugins.kotlin.parcelize)
     alias(libs.plugins.kotlin.serialization)
+    alias(libs.plugins.dokka)
 }
 
 android {
@@ -44,4 +45,23 @@ kotlin {
             implementation(libs.play.services.auth)
         }
     }
+}
+
+tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
+    // Output format (HTML by default)
+    outputDirectory.set(layout.buildDirectory.dir("dokka"))
+
+    // Module name in documentation
+    moduleName.set("feature")
+
+    // Documentation format
+    dokkaSourceSets {
+        configureEach {
+            sourceLink {
+                localDirectory.set(file("src"))
+                remoteUrl.set(uri("https://github.com/openMF/mobile-wallet.git").toURL())
+                remoteLineSuffix.set("#L")
+            }
+        }
+    }
 }

gradle.properties

@@ -23,7 +23,7 @@ org.gradle.configureondemand=false
 org.gradle.caching=true
 
 # Enable configuration caching between builds.
-org.gradle.configuration-cache=true
+org.gradle.configuration-cache=false
 # This option is set because of https://github.com/google/play-services-plugins/issues/246
 # to generate the Configuration Cache regardless of incompatible tasks.
 # See https://github.com/android/nowinandroid/issues/1022 before using it.
@@ -53,4 +53,5 @@ RblClientIdProp=a
 RblClientSecretProp=b
 
 kotlin.native.ignoreDisabledTargets=true
-kotlin.mpp.androidGradlePluginCompatibility.nowarn=true
+kotlin.mpp.androidGradlePluginCompatibility.nowarn=true
+

gradle/libs.versions.toml

@@ -366,3 +366,4 @@ ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
 spotless = { id = "com.diffplug.spotless", version.ref = "spotlessVersion" }
 version-catalog-linter = { id = "io.github.pemistahl.version-catalog-linter", version.ref = "versionCatalogLinterVersion" }
 
+dokka = { id = "org.jetbrains.dokka", version = "2.0.0" }