Merge pull request #26 from TechnourceDeveloper/dev_MainMenu

Add comments in functions and change git repo variable name

Author: TechnourceDeveloper

app/src/main/java/com/technource/android/preference/PreferenceHelper.kt

@@ -5,22 +5,22 @@ interface PreferenceHelper {
     /**
     Sets the selected language.
     @param language The language to be set.
-    */
+     */
     fun setLanguage(language: String)
     /**
     Retrieves the selected language.
     @return The selected language.
-    */
+     */
     fun getLanguage(): String
     /**
     Sets the language code for localization purposes.
     @param languageCode The language code to be set.
-    */
+     */
     fun setLanguageCode(languageCode: String)
     /**
     Retrieves the language code for localization.
     @return The language code.
-    */
+     */
     fun getLanguageCode(): String
     /**
     Sets the flag indicating whether the intro screen has been completed.
@@ -42,5 +42,8 @@ interface PreferenceHelper {
     @return True if the user is logged in, false otherwise.
      */
     fun isLoggedIn(): Boolean
+    /**
+    Clears all the stored preferences.
+     */
     fun clear()
 }

app/src/main/java/com/technource/android/ui/settingsModule/DrawerMenuItemAdapter.kt

@@ -16,10 +16,6 @@ class DrawerMenuItemAdapter(private var drawerMenu: List<DrawerMenu>) :
     private var rowIndex = 0
     private var oldSelectedPosition = 0
 
-    fun setOnItemClick(onItemClick: RecyclerviewInterface) {
-        setOnItemClick = onItemClick
-    }
-
     override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): DrawerMenuViewHolder {
         val view =
             DrawerMenuItemLayoutBinding.inflate(LayoutInflater.from(parent.context), parent, false)
@@ -74,6 +70,14 @@ class DrawerMenuItemAdapter(private var drawerMenu: List<DrawerMenu>) :
         return drawerMenu.size
     }
 
+    /**
+    Sets the click listener for the RecyclerView item.
+    @param onItemClick The click listener to be set.
+     */
+    fun setOnItemClick(onItemClick: RecyclerviewInterface) {
+        setOnItemClick = onItemClick
+    }
+
     class DrawerMenuViewHolder(val binding: DrawerMenuItemLayoutBinding) :
         RecyclerView.ViewHolder(binding.root)
 }

app/src/main/java/com/technource/android/ui/settingsModule/SettingsFragment.kt

@@ -57,7 +57,7 @@ class SettingsFragment(private val mActivity: AppCompatActivity) :
                     5 -> {
                         // Open the GitHub repository in a browser when "Git Repo" is selected
                         val uri: Uri =
-                            Uri.parse(Constants.gitRepo) // missing 'http://' will cause crashed
+                            Uri.parse(Constants.GIT_REPO_LINK) // missing 'http://' will cause crashed
 
                         val intent = Intent(Intent.ACTION_VIEW, uri)
                         startActivity(intent)
@@ -84,6 +84,17 @@ class SettingsFragment(private val mActivity: AppCompatActivity) :
         binding.logoutBtn.setOnClickListener { openLogoutDialog() }
     }
 
+
+    /**
+    Opens the logout dialog.
+    The dialog is created using a custom Dialog class and inflated with the logout_dialog.xml layout.
+    The layout parameters are set to match the parent view.
+    The dialog is set to be non-cancelable to prevent dismissing it by clicking outside.
+    Click listeners are set for the "Logout" button, "Cancel" button, and "Close" button.
+    When the "Logout" button is clicked, the user preferences are cleared, and the user is redirected to the LoginActivity.
+    The finishAffinity() method is called to finish all activities in the current task.
+    When the "Cancel" or "Close" button is clicked, the dialog is dismissed.
+     */
     private fun openLogoutDialog() {
         // Create and show the logout dialog
         val logoutDialog = Dialog(mActivity)
@@ -104,6 +115,15 @@ class SettingsFragment(private val mActivity: AppCompatActivity) :
         logoutDialog.show()
     }
 
+
+    /**
+    Adds data to the menu list in the drawer.
+    The existing drawerItemList is cleared.
+    DrawerMenu objects representing the menu items are created and added to the drawerItemList.
+    Each menu item consists of a title, subtitle, and icon.
+    The titles and icons are retrieved from resources using string resource IDs and drawable resource IDs.
+    The subtitle for the "Change Language" menu item is dynamically set based on the language code stored in preferences.
+     */
     private fun addDataInMenu() {
         drawerItemList.clear()
         drawerItemList.add(
@@ -151,6 +171,13 @@ class SettingsFragment(private val mActivity: AppCompatActivity) :
         drawerItemList.add(DrawerMenu(resources.getString(R.string.more), "", R.drawable.ic_more))
     }
 
+    /**
+    Refreshes the drawer menu.
+    Resets the isChangeLanguageSelected flag to false.
+    Adds data to the menu items in the drawer.
+    Notifies the drawerAdapter that the data set has changed.
+    Updates the text of the logout, deactivate, and delete account TextViews with the corresponding string resources.
+     */
     private fun refreshDrawer() {
         isChangeLanguageSelected = false
         addDataInMenu()

app/src/main/java/com/technource/android/utils/Constant.kt

@@ -8,7 +8,7 @@ class Constants {
         const val LANGUAGE_CODE = "language_code"
         const val IS_INTRO_SCREEN_DONE = "is_intro_screen_done"
         const val IS_LOGGED_IN = "is_logged_in"
-        const val gitRepo = "https://github.com/TechnourceDeveloper/Android-Kotlin-Boilarplate"
+        const val GIT_REPO_LINK = "https://github.com/TechnourceDeveloper/Android-Kotlin-Boilarplate"
         const val aboutUs = "https://www.technource.com/services/"
         const val termsNCondition = "https://www.technource.com/terms-conditions/"
         const val privacyPolicy = "https://technource.com/privacy-policy/"