Documentation Added for feature/client-charge (#2980)

Author: WizCoderr

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/chargeDetails/ChargeDetailScreen.kt

@@ -50,6 +50,13 @@ import org.mifos.mobile.core.ui.component.MifosPoweredCard
 import org.mifos.mobile.core.ui.utils.EventsEffect
 import mifos_mobile.core.ui.generated.resources.Res as uiRes
 
+/**
+ * ChargeDetailScreen is a composable function that displays the details of a charge.
+ *
+ * @param onNavigateBack A lambda function that is called when the user navigates back.
+ * @param modifier Modifier for the composable.
+ * @param viewModel The ChargeDetailsViewModel for the screen.
+ */
 @Composable
 internal fun ChargeDetailScreen(
     onNavigateBack: () -> Unit,
@@ -110,6 +117,13 @@ internal fun ChargeDetailScreen(
     )
 }
 
+/**
+ * ChargeDetailsPaidComponent is a composable function that displays the details of a paid charge.
+ *
+ * @param refNo Reference number of the charge.
+ * @param paidOn Date when the charge was paid.
+ * @param modifier Modifier for the composable.
+ */
 @Composable
 fun ChargeDetailsPaidComponent(
     refNo: String,
@@ -153,6 +167,13 @@ fun ChargeDetailsPaidComponent(
     }
 }
 
+/**
+ * ChargeDetailsUnPaidComponent is a composable function that displays the details of an unpaid charge.
+ *
+ * @param amountPaidOn Date when the charge was paid.
+ * @param onPayOutStanding A lambda function that is called when the user pays the outstanding amount.
+ * @param modifier Modifier for the composable.
+ */
 @Composable
 fun ChargeDetailsUnPaidComponent(
     amountPaidOn: String,

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/chargeDetails/ChargeDetailsRoute.kt

@@ -17,7 +17,19 @@ import kotlinx.serialization.Serializable
 import org.mifos.mobile.core.common.DateHelper
 import org.mifos.mobile.core.model.entity.Charge
 import org.mifos.mobile.core.ui.composableWithStayTransitions
-
+/**
+ * Route for the Charges Details Screen.
+ *
+ * @param title Title of the charge.
+ * @param date Date of the charge.
+ * @param due Due amount of the charge.
+ * @param paid Paid amount of the charge.
+ * @param waived Waived amount of the charge.
+ * @param outstanding Outstanding amount of the charge.
+ * @param refNo Reference number of the charge.
+ * @param paidOn Date when the charge was paid.
+ * @param isPaid Whether the charge is paid or not.
+ */
 @Serializable
 data class ChargesDetailsRoute(
     val title: String = "",
@@ -41,6 +53,11 @@ fun NavGraphBuilder.chargesDetailsDestination(onNavigateBack: () -> Unit) {
 
 // TODO: last charge paid On , needed that.
 // TODO: Add reference No instead of chargeId
+/**
+ * Navigates to the Charges Details Screen.
+ *
+ * @param charge Charge object containing the details of the charge.
+ */
 fun NavController.navigateToChargesDetailsScreen(charge: Charge) {
     this.navigate(
         ChargesDetailsRoute(

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/chargeDetails/ChargeDetailsViewModel.kt

@@ -21,6 +21,11 @@ import mifos_mobile.feature.client_charge.generated.resources.waived
 import org.jetbrains.compose.resources.StringResource
 import org.mifos.mobile.core.ui.utils.BaseViewModel
 
+/**
+ * ChargeDetailsViewModel is a view model that handles the logic for the Charge Details Screen.
+ *
+ * @param savedStateHandle SavedStateHandle for the view model.
+ */
 internal class ChargeDetailsViewModel(
     savedStateHandle: SavedStateHandle,
 ) : BaseViewModel<ChargeDetailsState, ChargeDetailsEvent, ChargeDetailsAction>(
@@ -42,7 +47,11 @@ internal class ChargeDetailsViewModel(
         )
     },
 ) {
-
+    /**
+     * Handles the actions for the Charge Details Screen.
+     *
+     * @param action The action to be handled.
+     */
     override fun handleAction(action: ChargeDetailsAction) {
         when (action) {
             ChargeDetailsAction.NavigateBack -> {
@@ -56,17 +65,36 @@ internal class ChargeDetailsViewModel(
     }
 }
 
+/**
+ * ChargeDetailsState is a data class that represents the state of the Charge Details Screen.
+ *
+ * @param details Map of charge details.
+ * @param isPaid Boolean indicating if the charge is paid.
+ * @param refNo Reference number of the charge.
+ * @param paidOn Date when the charge was paid.
+ */
 data class ChargeDetailsState(
     val details: Map<StringResource, String> = emptyMap(),
     val isPaid: Boolean = false,
     val refNo: String = "",
     val paidOn: String = "",
 )
 
+/**
+ * ChargeDetailsEvent is a sealed interface that represents the events for the Charge Details Screen.
+ *
+ * @param NavigateBack Navigates back to the previous screen.
+ */
 sealed interface ChargeDetailsEvent {
     data object NavigateBack : ChargeDetailsEvent
 }
 
+/**
+ * ChargeDetailsAction is a sealed interface that represents the actions for the Charge Details Screen.
+ *
+ * @param NavigateBack Navigates back to the previous screen.
+ * @param PayOutStanding Pays the outstanding amount of the charge.
+ */
 sealed interface ChargeDetailsAction {
     data object NavigateBack : ChargeDetailsAction
     data object PayOutStanding : ChargeDetailsAction

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/charges/ClientChargeRoute.kt

@@ -17,19 +17,37 @@ import kotlinx.serialization.Serializable
 import org.mifos.mobile.core.model.entity.Charge
 import org.mifos.mobile.core.ui.composableWithPushTransitions
 
+/**
+ * ClientChargesRoute is a data class that represents the route for the Client Charges Screen.
+ *
+ * @param chargeType Type of the charge.
+ * @param chargeTypeId ID of the charge.
+ */
 @Serializable
 data class ClientChargesRoute(
     val chargeType: String,
     val chargeTypeId: Long? = null,
 )
 
+/**
+ * Navigates to the Client Charges Screen.
+ *
+ * @param chargeType Type of the charge.
+ * @param chargeTypeId ID of the charge.
+ */
 fun NavController.navigateToClientChargeScreen(
     chargeType: String,
     chargeTypeId: Long?,
 ) {
     this.navigate(ClientChargesRoute(chargeType, chargeTypeId))
 }
 
+/**
+ * Composable function that displays the Client Charges Screen.
+ *
+ * @param onNavigateBack A lambda function that is called when the user navigates back.
+ * @param navigateToChargeDetailsScreen A lambda function that is called when the user clicks on a charge.
+ */
 fun NavGraphBuilder.clientChargesScreen(
     onNavigateBack: () -> Unit,
     navigateToChargeDetailsScreen: (charge: Charge) -> Unit,

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/charges/ClientChargeScreen.kt

@@ -44,7 +44,14 @@ import org.mifos.mobile.core.ui.component.MifosProgressIndicator
 import org.mifos.mobile.core.ui.utils.EventsEffect
 import org.mifos.mobile.core.ui.utils.ScreenUiState
 import org.mifos.mobile.feature.charge.components.ClientChargeItem
-
+/**
+ * Composable function that displays the Client Charges Screen.
+ *
+ * @param navigateBack A lambda function that is called when the user navigates back.
+ * @param onChargeClick A lambda function that is called when the user clicks on a charge.
+ * @param modifier Modifier to be applied to the layout.
+ * @param viewModel ViewModel that provides the state and actions for the screen.
+ */
 @Composable
 internal fun ClientChargeScreen(
     navigateBack: () -> Unit,
@@ -87,6 +94,13 @@ internal fun ClientChargeScreen(
     )
 }
 
+/**
+ * Composable function that displays the Client Charges Screen.
+ *
+ * @param state State of the screen.
+ * @param modifier Modifier to be applied to the layout.
+ * @param onAction A lambda function that is called when the user performs an action.
+ */
 @Composable
 private fun ClientChargeScreen(
     state: ClientChargeState,
@@ -149,6 +163,13 @@ private fun ClientChargeScreen(
     }
 }
 
+/**
+ * Composable function that displays the content of the Client Charges Screen.
+ *
+ * @param chargesList List of charges to be displayed.
+ * @param onChargeClick A lambda function that is called when the user clicks on a charge.
+ * @param modifier Modifier to be applied to the layout.
+ */
 @Composable
 private fun ClientChargeContent(
     chargesList: List<Charge>,
@@ -164,6 +185,12 @@ private fun ClientChargeContent(
     }
 }
 
+/**
+ * Composable function that displays the dialogs of the Client Charges Screen.
+ *
+ * @param dialogState Dialog state used for showing loading or error.
+ * @param onDismissRequest A lambda function that is called when the user dismisses the dialog.
+ */
 @Composable
 private fun ClientChargeDialogs(
     dialogState: ClientChargeState.DialogState?,

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/charges/ClientChargeViewModel.kt

@@ -125,6 +125,11 @@ internal class ClientChargeViewModel(
         }
     }
 
+    /**
+     * Handles the result of the network status.
+     *
+     * @param isOnline Boolean indicating if the network is online.
+     */
     private fun handleNetworkResult(isOnline: Boolean) {
         updateState {
             it.copy(networkStatus = isOnline)
@@ -146,6 +151,10 @@ internal class ClientChargeViewModel(
         }
     }
 
+    /**
+     * Retries loading charges if the network is available.
+     * If the network is not available, it sets the UI state to Network.
+     */
     private fun retry() {
         viewModelScope.launch {
             if (!state.networkStatus) {
@@ -304,67 +313,47 @@ data class ClientChargeState(
 
 /**
  * UI events emitted from the ViewModel to be handled by the UI layer.
+ *
+ * @property ShowToast Shows a toast message.
+ * @property Navigate Navigates to the charge creation screen.
+ * @property OnChargeClick Triggered when a user clicks on a charge item.
  */
 sealed interface ClientChargeEvent {
-    /**
-     * Shows a toast message.
-     * @param message Message to display.
-     */
     data class ShowToast(val message: String) : ClientChargeEvent
 
-    /** Navigates to the charge creation screen. */
     data object Navigate : ClientChargeEvent
 
-    /**
-     * Triggered when a charge item is clicked.
-     * @param charge The clicked charge.
-     */
     data class OnChargeClick(val charge: Charge) : ClientChargeEvent
 }
 
 /**
  * Actions dispatched from the UI or internal processes.
+ *
+ * @property RefreshCharges Refreshes the list of charges.
+ * @property OnNavigate Navigates to the charge creation screen.
+ * @property OnDismissDialog Dismisses any open dialog (error/loading).
+ * @property OnChargeClick Triggered when a user clicks on a charge item.
  */
 sealed interface ClientChargeAction {
 
-    /** Refreshes the list of charges. */
     data object RefreshCharges : ClientChargeAction
 
-    /** Navigates to the charge creation screen. */
     data object OnNavigate : ClientChargeAction
 
-    /** Dismisses any open dialog (error/loading). */
     data object OnDismissDialog : ClientChargeAction
 
-    /**
-     * Triggered when a user clicks on a charge item.
-     * @param charge The clicked charge.
-     */
     data class OnChargeClick(val charge: Charge) : ClientChargeAction
 
-    /** Receive the network status */
     data class ReceiveNetworkResult(val isOnline: Boolean) : ClientChargeAction
 
-    /** Action to trigger to refetch the charges */
     data object Retry : ClientChargeAction
 
-    /**
-     * Internal actions used by the ViewModel.
-     */
     sealed class Internal : ClientChargeAction {
 
-        /**
-         * Result from fetching loan or savings charges.
-         * @param result DataState containing a list of charges.
-         */
         data class ReceiveLoanOrSavingsChargesResult(
             val result: DataState<List<Charge>>,
         ) : Internal()
 
-        /**
-         * Result from fetching client charges.
-         * @param result DataState containing a paginated response.
-         */
         data class ReceiveClientChargesResult(
             val result: DataState<Page<Charge>>,
         ) : Internal()

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/components/ClientChargeItem.kt

@@ -41,6 +41,13 @@ import org.mifos.mobile.core.designsystem.theme.MifosMobileTheme
 import org.mifos.mobile.core.designsystem.theme.MifosTypography
 import org.mifos.mobile.core.model.entity.Charge
 
+/**
+ * Composable function that displays a charge item.
+ *
+ * @param charge The charge to be displayed.
+ * @param onChargeClick A lambda function that is called when the user clicks on a charge.
+ * @param modifier Modifier to be applied to the layout.
+ */
 @Composable
 fun ClientChargeItem(
     charge: Charge,

feature/client-charge/src/commonMain/kotlin/org/mifos/mobile/feature/charge/navigation/ClientChargesNavGraph.kt

@@ -25,6 +25,11 @@ import org.mifos.mobile.feature.charge.charges.clientChargesScreen
 @Serializable
 data object ClientChargesNavGraphRoute
 
+/**
+ * Navigation graph for the Client Charges Screen.
+ *
+ * @param navController The NavController to be used for navigation.
+ */
 fun NavGraphBuilder.clientChargeNavGraph(
     navController: NavController,
 //    navigateBack: () -> Unit,