add docstrings

Ethosa · Mar 11, 2022 · d212101 · d212101
1 parent 754ecff
commit d212101
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/app/src/main/java/com/ethosa/ktc/ui/adapters/SettingsAdapter.kt b/app/src/main/java/com/ethosa/ktc/ui/adapters/SettingsAdapter.kt
@@ -10,6 +10,9 @@ import com.ethosa.ktc.R
 import com.ethosa.ktc.databinding.LayoutSettingsButtonBinding
 import com.ethosa.ktc.ui.fragments.SettingsFragment
 
+/**
+ * Provides settings behavior.
+ */
 class SettingsAdapter (
     private val fragment: SettingsFragment
 ) : RecyclerView.Adapter<SettingsAdapter.ViewHolder>() {
@@ -20,6 +23,9 @@ class SettingsAdapter (
     private var actions: TypedArray = fragment.requireContext()
         .resources.obtainTypedArray(R.array.settings_actions)
 
+    /**
+     * Provides RecyclerView.ViewHolder behavior
+     */
     class ViewHolder(view: View) : RecyclerView.ViewHolder(view) {
         val binding = LayoutSettingsButtonBinding.bind(view)
     }

diff --git a/app/src/main/java/com/ethosa/ktc/ui/fragments/AboutAppFragment.kt b/app/src/main/java/com/ethosa/ktc/ui/fragments/AboutAppFragment.kt
@@ -9,9 +9,11 @@ import android.view.View
 import android.view.ViewGroup
 import com.ethosa.ktc.databinding.FragmentAboutAppBinding
 
+/**
+ * Provides About app fragment behavior.
+ */
 class AboutAppFragment : Fragment() {
     private var _binding: FragmentAboutAppBinding? = null
-
     private val binding get() = _binding!!
 
     override fun onCreateView(
@@ -23,6 +25,7 @@ class AboutAppFragment : Fragment() {
         _binding = FragmentAboutAppBinding.inflate(inflater, container, false)
 
         binding.authorGithub.setOnClickListener {
+            // Go to Github repo
             val intent = Intent(Intent.ACTION_VIEW)
             intent.data = Uri.parse("https://github.com/ethosa/ktc")
             startActivity(intent)