Documentation Added for feature/accounts (#2981)

Author: WizCoderr

feature/accounts/src/commonMain/kotlin/org/mifos/mobile/feature/accounts/accountTransactions/AccountsTransactionNavigation.kt

@@ -17,12 +17,26 @@ import androidx.navigation.NavOptions
 import kotlinx.serialization.Serializable
 import org.mifos.mobile.core.ui.composableWithSlideTransitions
 
+/**
+ * Navigation route for the Account Transactions Screen.
+ *
+ * @param accountType The type of account to be displayed.
+ * @param accountId The ID of the account to be displayed.
+ */
+
 @Serializable
 data class AccountTransactionsNavRoute(
     val accountType: String,
     val accountId: Long,
 )
 
+/**
+ * Navigates to the Account Transactions Screen with the specified account type and ID.
+ *
+ * @param accountType The type of account to be displayed.
+ * @param accountId The ID of the account to be displayed.
+ * @param navOptions Optional navigation options for the transaction screen.
+ */
 fun NavController.navigateToAccountTransactionsScreen(
     accountType: String,
     accountId: Long,
@@ -31,6 +45,11 @@ fun NavController.navigateToAccountTransactionsScreen(
     this.navigate(AccountTransactionsNavRoute(accountType, accountId), navOptions)
 }
 
+/**
+ * Adds the Account Transactions Screen to the navigation graph.
+ *
+ * @param navigateBack The function to be called when the back button is pressed.
+ */
 fun NavGraphBuilder.accountTransactionsDestination(
     navigateBack: () -> Unit,
 ) {

feature/accounts/src/commonMain/kotlin/org/mifos/mobile/feature/accounts/accountTransactions/TransactionScreen.kt

@@ -66,7 +66,12 @@ import org.mifos.mobile.core.ui.utils.EventsEffect
 import org.mifos.mobile.core.ui.utils.ScreenUiState
 import org.mifos.mobile.feature.accounts.component.FilterSection
 import org.mifos.mobile.feature.accounts.model.TransactionFilterType
-
+/**
+ * Composable function for the Account Transactions Screen.
+ *
+ * @param navigateBack The function to be called when the back button is pressed.
+ * @param viewModel The ViewModel for the Account Transactions Screen.
+ */
 @Composable
 internal fun TransactionScreen(
     navigateBack: () -> Unit,
@@ -97,6 +102,13 @@ internal fun TransactionScreen(
     )
 }
 
+/**
+ * Composable function for the Account Transactions Screen Content.
+ *
+ * @param state The current state of the Account Transactions Screen.
+ * @param onAction The function to be called when an action is performed.
+ * @param modifier Optional modifier for the content.
+ */
 @Composable
 internal fun TransactionScreenContent(
     state: AccountTransactionState,
@@ -206,6 +218,12 @@ internal fun TransactionScreenContent(
     }
 }
 
+/**
+ * Composable function for the Account Transactions Dialog.
+ *
+ * @param state The current state of the Account Transactions Screen.
+ * @param onAction The function to be called when an action is performed.
+ */
 @Composable
 internal fun AccountTransactionsDialog(
     state: AccountTransactionState,
@@ -232,6 +250,12 @@ internal fun AccountTransactionsDialog(
     }
 }
 
+/**
+ * Composable function for the Account Transactions Action Bar.
+ *
+ * @param onAction The function to be called when an action is performed.
+ * @param modifier Optional modifier for the action bar.
+ */
 @Composable
 internal fun ActionBar(
     onAction: (AccountTransactionAction) -> Unit,
@@ -289,6 +313,13 @@ internal fun ActionBar(
     }
 }
 
+/**
+ * Composable function for the Account Transactions Filters.
+ *
+ * @param state The current state of the Account Transactions Screen.
+ * @param onAction The function to be called when an action is performed.
+ * @param modifier Optional modifier for the filters.
+ */
 @Composable
 internal fun TransactionFilters(
     state: AccountTransactionState,

feature/accounts/src/commonMain/kotlin/org/mifos/mobile/feature/accounts/accountTransactions/TransactionViewModel.kt

@@ -159,6 +159,9 @@ internal class AccountsTransactionViewModel(
         }
     }
 
+    /**
+     * Handles the refresh action by checking the network status and loading transactions.
+     */
     private fun handleRefresh() {
         viewModelScope.launch {
             if (!state.networkStatus) {
@@ -170,6 +173,11 @@ internal class AccountsTransactionViewModel(
         }
     }
 
+    /**
+     * Handles the network result by updating the network status and UI state.
+     *
+     * @param isOnline Boolean indicating whether the network is online.
+     */
     private fun handleNetworkResult(isOnline: Boolean) {
         updateState {
             it.copy(networkStatus = isOnline)
@@ -376,6 +384,10 @@ internal class AccountsTransactionViewModel(
         }
     }
 
+    /**
+     * Handles the result of the savings transactions API call by updating the UI state
+     * based on [DataState] — success, loading, or error.
+     */
     private fun handleSavingsTransactionsResult(dataState: DataState<SavingsWithAssociations>) {
         when (dataState) {
             is DataState.Error -> {
@@ -428,6 +440,10 @@ internal class AccountsTransactionViewModel(
         }
     }
 
+    /**
+     * Handles the result of the loan transactions API call by updating the UI state
+     * based on [DataState] — success, loading, or error.
+     */
     private fun handleLoanTransactionsResult(dataState: DataState<LoanWithAssociations?>) {
         when (dataState) {
             is DataState.Error -> {
@@ -688,6 +704,14 @@ internal data class AccountTransactionState(
 
 /**
  * Sealed interface representing actions that can be performed on the account transactions screen.
+ * @property Refresh Action to refresh the transaction data.
+ * @property DismissDialog Action to dismiss any currently shown dialog.
+ * @property OnNavigateBackClick Action to navigate back to the previous screen.
+ * @property ToggleFilter Action to toggle the visibility of the filter dialog.
+ * @property ResetFilters Action to reset all filters to their default state.
+ * @property GetFilterResults Action to get the results of the filter dialog.
+ * @property ReceiveNetworkResult Action to receive the result of the network status check.
+ * @property ToggleCheckbox Action to toggle a specific checkbox filter.
  */
 internal sealed interface AccountTransactionAction {
     data object Refresh : AccountTransactionAction
@@ -746,6 +770,7 @@ internal sealed interface AccountTransactionAction {
 
 /**
  * Sealed interface representing one-time events to be sent to the UI.
+ * @property OnNavigateBack Event to navigate back to the previous screen.
  */
 sealed interface AccountTransactionEvent {
     data object OnNavigateBack : AccountTransactionEvent

feature/accounts/src/commonMain/kotlin/org/mifos/mobile/feature/accounts/accounts/AccountNavigation.kt

@@ -17,18 +17,35 @@ import androidx.navigation.NavOptions
 import kotlinx.serialization.Serializable
 import org.mifos.mobile.core.ui.composableWithSlideTransitions
 
+/**
+ * Navigation route for the Accounts Screen.
+ *
+ * @param accountType The type of account to be displayed.
+ */
 @Serializable
 data class AccountNavRoute(
     val accountType: String,
 )
 
+/**
+ * Navigates to the Accounts Screen.
+ *
+ * @param accountType The type of account to be displayed.
+ * @param navOptions The navigation options to be applied.
+ */
 fun NavController.navigateToAccountsScreen(
     accountType: String,
     navOptions: NavOptions? = null,
 ) {
     this.navigate(AccountNavRoute(accountType), navOptions)
 }
 
+/**
+ * Adds the Accounts Screen to the navigation graph.
+ *
+ * @param navigateBack The function to be called when the back button is pressed.
+ * @param onAccountClicked The function to be called when an account is clicked.
+ */
 fun NavGraphBuilder.accountsDestination(
     navigateBack: () -> Unit,
     onAccountClicked: (accountType: String, accountId: Long) -> Unit,

feature/accounts/src/commonMain/kotlin/org/mifos/mobile/feature/accounts/accounts/AccountsScreen.kt

@@ -54,7 +54,13 @@ import org.mifos.mobile.feature.accounts.model.FilterType
 import org.mifos.mobile.feature.loanaccount.loanAccount.LoanAccountScreen
 import org.mifos.mobile.feature.savingsaccount.savingsAccount.SavingsAccountScreen
 import org.mifos.mobile.feature.shareaccount.shareAccount.ShareAccountScreen
-
+/**
+ * Composable function that displays the Accounts Screen.
+ *
+ * @param navigateBack The function to be called when the back button is pressed.
+ * @param onAccountClicked The function to be called when an account is clicked.
+ * @param viewModel The ViewModel to be used for the screen.
+ */
 @Composable
 internal fun AccountsScreen(
     navigateBack: () -> Unit,
@@ -87,6 +93,13 @@ internal fun AccountsScreen(
     )
 }
 
+/**
+ * Composable function that displays the Accounts Dialog.
+ *
+ * @param state The state of the screen.
+ * @param onAction The function to be called when an action is performed.
+ * @param modifier Modifier to be applied to the layout.
+ */
 @Composable
 internal fun AccountsDialog(
     state: AccountsState,
@@ -111,6 +124,13 @@ internal fun AccountsDialog(
     }
 }
 
+/**
+ * Composable function that displays the Savings Account Filters Dialog.
+ *
+ * @param state The state of the screen.
+ * @param onAction The function to be called when an action is performed.
+ * @param modifier Modifier to be applied to the layout.
+ */
 @Composable
 internal fun SavingsAccountFilters(
     state: AccountsState,
@@ -182,6 +202,13 @@ internal fun SavingsAccountFilters(
     }
 }
 
+/**
+ * Composable function that displays the Account Screen Content.
+ *
+ * @param state The state of the screen.
+ * @param onAction The function to be called when an action is performed.
+ * @param modifier Modifier to be applied to the layout.
+ */
 @Composable
 internal fun AccountScreenContent(
     state: AccountsState,

feature/accounts/src/commonMain/kotlin/org/mifos/mobile/feature/accounts/accounts/AccountsViewModel.kt

@@ -205,91 +205,82 @@ internal class AccountsViewModel(
 /**
  * UI state for the Accounts screen, containing filter options, dialog visibility,
  * current account type, and refresh signals.
+ *
+ * @property isRefreshing Indicates if the screen is currently refreshing data.
+ * @property checkboxOptions List of checkboxes for filter options.
+ * @property selectedFilters List of currently selected filters.
+ * @property accountType Current account type filter.
+ * @property toggleFilterDialog Whether the filter dialog is open.
+ * @property accountTypeFiltersCount Count of selected account type filters.
+ * @property accountStatusFiltersCount Count of selected account status filters.
+ * @property refreshSignal Signal to trigger data refresh.
+ * @property dialogState Current dialog state (Error or Filters).
+ * @property uiState Overall UI state of the screen (Loading, Success, Error).
+ *
  */
 internal data class AccountsState
 @OptIn(ExperimentalTime::class)
 constructor(
     val isRefreshing: Boolean = false,
-
-    /** Current filter checkboxes shown in the dialog */
     val checkboxOptions: List<CheckboxStatus> = emptyList(),
-
-    /** Confirmed filters applied to the data */
     val selectedFilters: List<CheckboxStatus> = emptyList(),
-
-    /** Selected account type (Savings, Loan, Share) */
     val accountType: AccountType = AccountType.SAVINGS,
-
-    /** Whether filter dialog is visible */
     val toggleFilterDialog: Boolean = false,
-
-    /** Count of selected account-type filters */
     val accountTypeFiltersCount: Int? = 0,
-
-    /** Count of selected status filters */
     val accountStatusFiltersCount: Int? = 0,
-
-    /** Used to trigger data refresh downstream */
     val refreshSignal: Long = Clock.System.now().epochSeconds,
-
-    /** Current dialog being shown (loading, filters, error) */
     val dialogState: DialogState? = null,
-
-    /** Hold the state of the screen */
     val uiState: ScreenUiState = ScreenUiState.Loading,
 ) {
 
-    /**
-     * Defines various dialog states in the Accounts screen.
-     */
     sealed interface DialogState {
         data class Error(val message: String) : DialogState
         data object Filters : DialogState
     }
 
-    /** True if any checkbox is selected */
     val isAnyFilterSelected = checkboxOptions.any { it.isChecked }
 }
 
 /**
  * Defines all user or internal actions that can be triggered in the Accounts screen.
+ *
+ * @property ToggleFilter Opens or closes the filter dialog
+ * @property ResetFilters Clears all filters and selections
+ * @property DismissDialog Dismisses any open dialog
+ * @property GetFilterResults Applies filter and triggers refresh
+ * @property OnNavigateBack Handles back navigation
+ * @property Refresh Initiates refresh of data
+ * @property RefreshCompleted Signals that refresh is done
+ * @property OnAccountClicked When an account card is clicked
+ * @property SetCheckboxFilterList Sets the checkbox list based on account type
+ * @property ToggleCheckbox Toggles a specific checkbox in the dialog
  */
 internal sealed interface AccountsAction {
 
-    /** Opens or closes the filter dialog */
     data object ToggleFilter : AccountsAction
 
-    /** Clears all filters and selections */
     data object ResetFilters : AccountsAction
 
-    /** Dismisses any open dialog */
     data object DismissDialog : AccountsAction
 
-    /** Applies filter and triggers refresh */
     data object GetFilterResults : AccountsAction
 
-    /** Handles back navigation */
     data object OnNavigateBack : AccountsAction
 
-    /** Initiates refresh of data */
     data object Refresh : AccountsAction
 
-    /** Signals that refresh is done */
     data object RefreshCompleted : AccountsAction
 
-    /** When an account card is clicked */
     data class OnAccountClicked(
         val accountId: Long,
         val accountType: String,
     ) : AccountsAction
 
-    /** Sets the checkbox list based on account type */
     data class SetCheckboxFilterList(
         val checkBoxList: List<CheckboxStatus>,
         val accountType: String,
     ) : AccountsAction
 
-    /** Toggles a specific checkbox */
     data class ToggleCheckbox(
         val label: StringResource,
         val type: FilterType,
@@ -298,13 +289,13 @@ internal sealed interface AccountsAction {
 
 /**
  * Defines one-time events sent from AccountsViewModel to UI.
+ * @property NavigateBack Navigate back to previous screen
+ * @property AccountClicked Navigate to account detail screen
  */
 sealed interface AccountsEvent {
 
-    /** Navigate back to previous screen */
     data object NavigateBack : AccountsEvent
 
-    /** Navigate to account detail screen */
     data class AccountClicked(
         val accountId: Long,
         val accountType: String,