feature(#137): add comments for changed classes and functions

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/data/models/chat/AutoTaskModel.kt

@@ -1,6 +1,8 @@
 package com.matthaigh27.chatgptwrapper.data.models.chat
 
-import javax.annotation.ParametersAreNullableByDefault
+/**
+ * This class denotes a model to store AutoTask data in Firebase realtime database.
+ */
 
 data class AutoTaskModel(
     val command: Command? = null,

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/ui/chat/view/ChatActivity.kt

@@ -29,6 +29,10 @@ class ChatActivity : BaseActivity() {
     }
 
     private fun requestPermissions() {
+        /**
+         * In mobile phones that use Google API 33 or higher, the permission for reading external storage
+         * is disabled because the phones don't support the feature.
+         */
         permissions = if(Build.VERSION.SDK_INT > Build.VERSION_CODES.S_V2) {
             arrayOf(
                 Manifest.permission.SEND_SMS,

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/ui/chat/view/fragments/ChatMainFragment.kt

@@ -2,7 +2,6 @@ package com.matthaigh27.chatgptwrapper.ui.chat.view.fragments
 
 import android.annotation.SuppressLint
 import android.os.Bundle
-import android.util.Log
 import android.view.KeyEvent
 import android.view.LayoutInflater
 import android.view.View
@@ -18,16 +17,9 @@ import androidx.fragment.app.Fragment
 import androidx.lifecycle.ViewModelProvider
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
-import com.google.firebase.database.ChildEventListener
-import com.google.firebase.database.DataSnapshot
-import com.google.firebase.database.DatabaseError
-import com.google.firebase.database.ktx.database
-import com.google.firebase.database.ktx.getValue
-import com.google.firebase.ktx.Firebase
 import com.google.gson.JsonElement
 import com.google.gson.JsonObject
 import com.matthaigh27.chatgptwrapper.R
-import com.matthaigh27.chatgptwrapper.data.models.chat.AutoTaskModel
 import com.matthaigh27.chatgptwrapper.data.models.chat.ChatMessageModel
 import com.matthaigh27.chatgptwrapper.data.models.chat.HelpCommandModel
 import com.matthaigh27.chatgptwrapper.data.models.chat.HelpPromptModel
@@ -356,28 +348,28 @@ class ChatMainFragment : Fragment(), OnClickListener {
 
     private fun fetchImageRelatedness(imageName: String, message: String) {
         viewModel.getImageRelatedness(imageName, message).observe(viewLifecycleOwner) { resource ->
-                when (resource) {
-                    is ApiResource.Loading -> {
-                        showLoading(true)
-                    }
+            when (resource) {
+                is ApiResource.Loading -> {
+                    showLoading(true)
+                }
 
-                    is ApiResource.Success -> {
-                        showLoading(false)
-                        addMessage(
-                            type = TYPE_CHAT_RECEIVE,
-                            content = resource.data?.description,
-                            data = null,
-                            hasImage = true,
-                            image = resource.data?.image
-                        )
-                    }
+                is ApiResource.Success -> {
+                    showLoading(false)
+                    addMessage(
+                        type = TYPE_CHAT_RECEIVE,
+                        content = resource.data?.description,
+                        data = null,
+                        hasImage = true,
+                        image = resource.data?.image
+                    )
+                }
 
-                    is ApiResource.Error -> {
-                        showLoading(false)
-                        addErrorMessage(resource.message!!)
-                    }
+                is ApiResource.Error -> {
+                    showLoading(false)
+                    addErrorMessage(resource.message!!)
                 }
             }
+        }
     }
 
     private fun sendNotification(message: String) {
@@ -491,6 +483,11 @@ class ChatMainFragment : Fragment(), OnClickListener {
         }
     }
 
+    /**
+     * This function is implemented to fetch the AutoTask data from the Firebase Realtime Database.
+     * If the 'result' property is present, its value will be displayed.
+     * if not, then the value of the 'thoughts' property will be exhibited.
+     */
     private fun fetchResponseAutoTask(apiResponse: ApiResponse<CommonResult>) {
         val referenceUrl = apiResponse.result.content.asString
         viewModel.getAutoTaskRealtimeData(
@@ -499,7 +496,7 @@ class ChatMainFragment : Fragment(), OnClickListener {
             when (resource) {
                 is ApiResource.Loading -> {
                     resource.data?.let { data ->
-                        if(data.result == null) {
+                        if (data.result == null) {
                             data.thoughts?.let { thoughts ->
                                 addMessage(
                                     type = TYPE_CHAT_RECEIVE,
@@ -577,24 +574,24 @@ class ChatMainFragment : Fragment(), OnClickListener {
             override fun pickImage(isSuccess: Boolean, data: ByteArray?) {
                 if (!isSuccess) addErrorMessage("Fail to pick image")
                 viewModel.uploadImageToFirebase(data!!).observe(viewLifecycleOwner) { resource ->
-                        when (resource) {
-                            is ApiResource.Loading -> {
-                                showLoading(true)
-                            }
+                    when (resource) {
+                        is ApiResource.Loading -> {
+                            showLoading(true)
+                        }
 
-                            is ApiResource.Success -> {
-                                showLoading(false)
-                                currentSelectedImage = data
-                                currentUploadedImageName = resource.data
-                                isImagePicked = true
-                            }
+                        is ApiResource.Success -> {
+                            showLoading(false)
+                            currentSelectedImage = data
+                            currentUploadedImageName = resource.data
+                            isImagePicked = true
+                        }
 
-                            is ApiResource.Error -> {
-                                addErrorMessage(resource.message!!)
-                                showLoading(false)
-                            }
+                        is ApiResource.Error -> {
+                            addErrorMessage(resource.message!!)
+                            showLoading(false)
                         }
                     }
+                }
             }
 
             override fun setAlarm(hours: Int, minutes: Int, label: String) {

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/ui/chat/viewmodel/ChatViewModel.kt

@@ -243,6 +243,11 @@ class ChatViewModel : ViewModel() {
         return resource
     }
 
+    /**
+     * This function is used to retrieve real-time data for the auto task.
+     * Whenever data in the Firebase real-time database changes,
+     * the data is converted to the AutoTaskModel and sent back to the View.
+     */
     fun getAutoTaskRealtimeData(referencePath: String): MutableLiveData<ApiResource<AutoTaskModel>> {
         val resource: MutableLiveData<ApiResource<AutoTaskModel>> =
             MutableLiveData()