Add comments in functions

Author: “TechnourceDeveloper”

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

@@ -98,6 +98,16 @@ fun Toast.successToast(message: String, activity: Activity) {
     }
 }
 
+/**
+Checks if a password is valid based on the following criteria:
+Contains at least one uppercase letter
+Contains at least one lowercase letter
+Contains at least one digit
+Contains at least one special character from the set [!@#$&*~]
+Has a minimum length of 8 characters
+@param password The password to be validated.
+@return true if the password is valid, false otherwise.
+*/
 fun isValidPassword(password: String): Boolean {
     val pattern: Pattern
     val PASSWORD_PATTERN = "^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[!@#\\\$&*~]).{8,}\$"
@@ -106,11 +116,21 @@ fun isValidPassword(password: String): Boolean {
     return matcher.matches()
 }
 
+/**
+Checks if an email address is valid.
+@param email The email address to be validated.
+@return true if the email address is valid, false otherwise.
+ */
 fun isValidEmail(email: String): Boolean {
     val pattern = Patterns.EMAIL_ADDRESS
     return pattern.matcher(email).matches()
 }
 
+/**
+Validates an email address and returns the validation status.
+@param email The email address to be validated.
+@return The ValidationStatus enum indicating the validation status of the email.
+ */
 fun validateEmail(email: String?): ValidationStatus {
     return when {
         email.isNullOrEmpty() -> ValidationStatus.EMPTY_EMAIL
@@ -119,6 +139,11 @@ fun validateEmail(email: String?): ValidationStatus {
     }
 }
 
+/**
+Validates a password and returns the validation status.
+@param password The password to be validated.
+@return The ValidationStatus enum indicating the validation status of the password.
+ */
 fun validatePassword(password: String?): ValidationStatus {
     return when {
         password.isNullOrEmpty() -> ValidationStatus.EMPTY_PASSWORD
@@ -127,48 +152,84 @@ fun validatePassword(password: String?): ValidationStatus {
     }
 }
 
+/**
+Validates a first name and returns the validation status.
+@param v The first name to be validated.
+@return The ValidationStatus enum indicating the validation status of the first name.
+ */
 fun validFirstName(v: String?): ValidationStatus {
     return when {
         v.isNullOrEmpty() -> ValidationStatus.EMPTY_FIRSTNAME
         else -> ValidationStatus.VALID
     }
 }
 
+/**
+Validates a last name and returns the validation status.
+@param v The last name to be validated.
+@return The ValidationStatus enum indicating the validation status of the last name.
+ */
 fun validLastName(v: String?): ValidationStatus {
     return when {
         v.isNullOrEmpty() -> ValidationStatus.EMPTY_LASTNAME
         else -> ValidationStatus.VALID
     }
 }
 
+/**
+Validates a username and returns the validation status.
+@param v The username to be validated.
+@return The ValidationStatus enum indicating the validation status of the username.
+ */
 fun validUsername(v: String?): ValidationStatus {
     return when {
         v.isNullOrEmpty() -> ValidationStatus.EMPTY_USERNAME
         else -> ValidationStatus.VALID
     }
 }
 
+/**
+Validates a home address and returns the validation status.
+@param v The home address to be validated.
+@return The ValidationStatus enum indicating the validation status of the home address.
+ */
 fun validHomeAddress(v: String?): ValidationStatus {
     return when {
         v.isNullOrEmpty() -> ValidationStatus.EMPTY_USERNAME
         else -> ValidationStatus.VALID
     }
 }
 
+/**
+Validates an office address and returns the validation status.
+@param v The office address to be validated.
+@return The ValidationStatus enum indicating the validation status of the office address.
+ */
 fun validOfficeAddress(v: String?): ValidationStatus {
     return when {
         v.isNullOrEmpty() -> ValidationStatus.EMPTY_USERNAME
         else -> ValidationStatus.VALID
     }
 }
 
+/**
+Validates a mobile number and returns the validation status.
+@param v The mobile number to be validated.
+@return The ValidationStatus enum indicating the validation status of the mobile number.
+ */
 fun validMobile(v: String?): ValidationStatus {
     return when {
         v.isNullOrEmpty() -> ValidationStatus.EMPTY_MOBILENO
         else -> ValidationStatus.VALID
     }
 }
 
+/**
+Validates the confirm password and returns the validation status.
+@param password The password entered by the user.
+@param confirmPassword The confirm password entered by the user.
+@return The ValidationStatus enum indicating the validation status of the confirm password.
+ */
 fun validConfirmPassword(password: String?, confirmPassword: String?): ValidationStatus {
     // validate confirm password
     if (TextUtils.isEmpty(confirmPassword)) {
@@ -180,12 +241,21 @@ fun validConfirmPassword(password: String?, confirmPassword: String?): Validatio
     return ValidationStatus.VALID
 }
 
+/**
+Retrieves the error message for a specific ValidationStatus.
+@param context The context used to retrieve the string resources.
+@return The error message corresponding to the ValidationStatus.
+ */
 fun ValidationStatus.getErrorMessage(context: Context): String? {
     val errorMessageResId = ValidationConstants.validationStatusErrorMap[this]
     return errorMessageResId?.let { context.getString(it) }
 }
 
-// Function to hide the keyboard
+/**
+Hides the keyboard.
+@param context The context used to retrieve the input method manager.
+@param view The view from which to retrieve the window token.
+ */
 fun hideKeyboard(context: Context, view: View) {
     val inputMethodManager =
         context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager

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

@@ -8,11 +8,18 @@ import android.os.Build
 import android.preference.PreferenceManager
 import java.util.*
 
-
+/**
+Helper class to manage the application's locale and language settings.
+ */
 object LocaleHelper {
     private const val SELECTED_LANGUAGE = "Locale.Helper.Selected.Language"
 
-    // the method is used to set the language at runtime
+    /**
+    Sets the locale for the application.
+    @param context The context.
+    @param language The language code (e.g., "en", "fr").
+    @return The updated context with the new locale.
+     */
     fun setLocale(context: Context, language: String): Context {
         persist(context, language)
 
@@ -23,15 +30,24 @@ object LocaleHelper {
         // for devices having lower version of android os
     }
 
+    /**
+    Persists the selected language in the shared preferences.
+    @param context The context.
+    @param language The selected language.
+     */
     private fun persist(context: Context, language: String) {
         val preferences = PreferenceManager.getDefaultSharedPreferences(context)
         val editor = preferences.edit()
         editor.putString(SELECTED_LANGUAGE, language)
         editor.apply()
     }
 
-    // the method is used update the language of application by creating
-    // object of inbuilt Locale class and passing language argument to it
+    /**
+    Updates the resources configuration with the specified language for devices running on Android Nougat (API level 24) or higher.
+    @param context The context.
+    @param language The language code (e.g., "en", "fr").
+    @return The updated context with the new resources configuration.
+     */
     @TargetApi(Build.VERSION_CODES.N)
     private fun updateResources(context: Context, language: String): Context {
         val locale = Locale(language)
@@ -42,6 +58,12 @@ object LocaleHelper {
         return context.createConfigurationContext(configuration)
     }
 
+    /**
+    Updates the resources configuration with the specified language for devices running on Android versions lower than Nougat (API level 24).
+    @param context The context.
+    @param language The language code (e.g., "en", "fr").
+    @return The updated context with the new resources configuration.
+     */
     private fun updateResourcesLegacy(context: Context, language: String): Context {
         val locale = Locale(language)
         Locale.setDefault(locale)

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

@@ -2,7 +2,9 @@ package com.technource.android.utils
 
 import com.example.android_kotlin_boilerplate.R
 
-
+/**
+Object containing constants related to validation.
+ */
 object ValidationConstants {
     // The validationStatusErrorMap is a map that maps each validation status to its corresponding error message resource ID.
     val validationStatusErrorMap = mapOf(

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

@@ -1,5 +1,8 @@
 package com.technource.android.utils
 
+/**
+Enum class representing the validation status for various fields.
+ */
 enum class ValidationStatus {
     VALID,
     EMPTY_EMAIL,