some main updates

Author: WizCoderr

feature/beneficiary/src/commonMain/kotlin/org/mifos/mobile/feature/beneficiary/beneficiaryApplication/BeneficiaryApplicationScreen.kt

@@ -122,7 +122,8 @@ private fun BeneficiaryApplicationDialogs(
 /**
  * Composable function to display the beneficiary application screen.
  *
- * It displays a progress indicator when the UI state is loading, a network error component when the network status is false, and the beneficiary application content when the UI state is success.
+ * It displays a progress indicator when the UI state is loading, a network error component
+ * when the network status is false, and the beneficiary application content when the UI state is success.
  *
  * @param state the current state of the screen.
  * @param onAction a function to handle user actions.

feature/beneficiary/src/commonMain/kotlin/org/mifos/mobile/feature/beneficiary/beneficiaryDetail/BeneficiaryDetailViewModel.kt

@@ -130,10 +130,8 @@ internal class BeneficiaryDetailViewModel(
 
     /**
      * Handles the response from the beneficiary list API and updates the view model state accordingly.
-     *
-     * If the response is loading, the view model state is updated to show a loading state.
-     * If the response is an error, the view model state is updated to show an error state.
-     * If the response is successful, the view model state is updated to show a success state and the beneficiary is updated to the one with the matching ID.
+     * If the response is successful, the view model state is updated to show a success state and
+     * the beneficiary is updated to the one with the matching ID.
      *
      * @param beneficiary The response from the beneficiary list API.
      */
@@ -198,7 +196,8 @@ internal class BeneficiaryDetailViewModel(
      * Processes the result of the delete beneficiary API.
      *
      * If the response is loading, the view model state is updated to show an overlay.
-     * If the response is an error, the view model state is updated to show an error state and a dialog is shown with a generic error message.
+     * If the response is an error, the view model state is updated to show an error state and a dialog
+     * is shown with a generic error message.
      * If the response is successful, the view model state is updated to navigate back to the previous screen.
      *
      * @param response The response from the delete beneficiary API.

feature/beneficiary/src/commonMain/kotlin/org/mifos/mobile/feature/beneficiary/beneficiaryList/BeneficiaryListNavigation.kt

@@ -31,7 +31,8 @@ fun NavController.navigateToBeneficiaryListScreen() {
  *
  * @param navigateBack a function to navigate back to the previous screen.
  * @param addBeneficiaryClicked a function to navigate to the add beneficiary screen.
- * @param onBeneficiaryItemClick a function to navigate to a beneficiary detail screen when a beneficiary item is clicked.
+ * @param onBeneficiaryItemClick a function to navigate to a beneficiary detail screen when a
+ * beneficiary item is clicked.
  */
 fun NavGraphBuilder.beneficiaryListScreen(
     navigateBack: () -> Unit,

feature/beneficiary/src/commonMain/kotlin/org/mifos/mobile/feature/beneficiary/beneficiaryList/BeneficiaryListScreen.kt

@@ -80,7 +80,8 @@ import org.mifos.mobile.core.ui.utils.ScreenUiState
  *
  * @param navigateBack The callback to navigate back to the previous screen.
  * @param addBeneficiaryClicked The callback to navigate to the add beneficiary screen.
- * @param onBeneficiaryItemClick The callback to navigate to a beneficiary detail screen when a beneficiary item is clicked.
+ * @param onBeneficiaryItemClick The callback to navigate to a beneficiary detail screen when a
+ * beneficiary item is clicked.
  * @param modifier The modifier to apply to the composable.
  * @param viewModel The view model to use for the beneficiary list screen.
  */

feature/beneficiary/src/commonMain/kotlin/org/mifos/mobile/feature/beneficiary/beneficiaryList/BeneficiaryListViewModel.kt

@@ -406,72 +406,31 @@ data class BeneficiaryListState(
  * @param OnAccountChange Change the selected account.
  */
 sealed interface BeneficiaryListAction {
-    /**
-     * Refresh the list of beneficiaries.
-     */
+
     data object RefreshBeneficiaries : BeneficiaryListAction
 
-    /**
-     * Add a new beneficiary.
-     */
     data object OnAddBeneficiaryClicked : BeneficiaryListAction
 
-    /**
-     * Click on a beneficiary item.
-     */
     data class OnBeneficiaryItemClick(val position: Long) : BeneficiaryListAction
 
-    /**
-     * Navigate to another screen.
-     */
     data object OnNavigate : BeneficiaryListAction
 
-    /**
-     * Toggle the filter dialog.
-     */
     data object ToggleFilter : BeneficiaryListAction
 
-    /**
-     * Reset the filters.
-     */
     data object ResetFilters : BeneficiaryListAction
 
-    /**
-     * Get the filter results.
-     */
     data object GetFilterResults : BeneficiaryListAction
 
-    /**
-     * Dismiss the dialog.
-     */
     data object DismissDialog : BeneficiaryListAction
 
-    /**
-     * Change the selected account.
-     */
     data class OnAccountChange(val account: String) : BeneficiaryListAction
 
-    /**
-     * Change the selected office.
-     */
     data class OnOfficeChange(val office: String) : BeneficiaryListAction
 
-    /**
-     * Load the beneficiaries.
-     */
     data object LoadBeneficiaries : BeneficiaryListAction
-
-    /**
-     * Receive the network status.
-     */
     data class ReceiveNetworkStatus(val isOnline: Boolean) : BeneficiaryListAction
 
     sealed interface Internal : BeneficiaryListAction {
-
-        /**
-         * Receive the beneficiary result.
-         * @param beneficiaryList The list of beneficiaries.
-         */
         data class ReceiveBeneficiaryResult(
             val beneficiaryList: DataState<List<Beneficiary>>,
         ) : Internal
@@ -486,18 +445,7 @@ sealed interface BeneficiaryListAction {
  * @param Navigate Navigate to another screen.
  */
 sealed interface BeneficiaryListEvent {
-    /**
-     * Add a new beneficiary.
-     */
     data object AddBeneficiaryClicked : BeneficiaryListEvent
-
-    /**
-     * Click on a beneficiary item.
-     */
     data class BeneficiaryItemClick(val position: Long) : BeneficiaryListEvent
-
-    /**
-     * Navigate to another screen.
-     */
     data object Navigate : BeneficiaryListEvent
 }

feature/beneficiary/src/commonMain/kotlin/org/mifos/mobile/feature/beneficiary/navigation/BeneficiaryNavRoute.kt

@@ -41,18 +41,24 @@ fun NavController.navigateToBeneficiaryNavGraph(navOptions: NavOptions? = null)
     navigate(BeneficiaryNavRoute, navOptions)
 
 /**
- * Adds a navigation graph for the beneficiary feature to the NavGraphBuilder.
+ * Adds a navigation graph for the beneficiary feature.
  *
- * @param navController the NavController that will be used to navigate through the graph.
- * @param navigateToQR a function that will be called when the user clicks on the QR code button.
- * @param navigateToStatusScreen a function that will be called when the user needs to view the status of a beneficiary.
- * The function takes in the following parameters:
- *  - beneficiaryId: the ID of the beneficiary.
- *  - name: the name of the beneficiary.
- *  - accountType: the account type of the beneficiary.
- *  - accountNumber: the account number of the beneficiary.
- *  - officeName: the office name of the beneficiary.
- * @param navigateToAuthenticateScreen a function that will be called when the user needs to authenticate to complete an action.
+ * The navigation graph has the following destinations:
+ * - Beneficiary List Screen: The screen that displays the list of all beneficiaries.
+ * - Manual Beneficiary Add Screen: The screen that allows the user to manually add a beneficiary.
+ * - Beneficiary Application Confirmation Screen: The screen that confirms the addition of a beneficiary.
+ * - Beneficiary Detail Screen: The screen that displays the details of a beneficiary.
+ *
+ * The navigation graph is structured as follows:
+ * - The Beneficiary List Screen is the starting point of the graph.
+ * - The Manual Beneficiary Add Screen is reachable from the Beneficiary List Screen.
+ * - The Beneficiary Application Confirmation Screen is reachable from the Manual Beneficiary Add Screen.
+ * - The Beneficiary Detail Screen is reachable from the Beneficiary List Screen and the Manual Beneficiary Add Screen.
+ *
+ * @param navController The navigation controller to use for navigation.
+ * @param navigateToQR A function to navigate to the QR code screen.
+ * @param navigateToStatusScreen A function to navigate to the status screen.
+ * @param navigateToAuthenticateScreen A function to navigate to the authentication screen.
  */
 fun NavGraphBuilder.beneficiaryNavGraph(
     navController: NavController,