Added small documentation containing current information about the cl…

…asses involved in the PR.
MaximeZmt · Mar 24, 2022 · fbf2ba3 · fbf2ba3
1 parent ca96954
commit fbf2ba3
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/app/src/main/java/ch/sdp/vibester/activity/GameEndingActivity.kt b/app/src/main/java/ch/sdp/vibester/activity/GameEndingActivity.kt
@@ -6,7 +6,10 @@ import android.view.View
 import android.widget.TextView
 import androidx.appcompat.app.AppCompatActivity
 import ch.sdp.vibester.R
-
+/*
+ * A class representing the activity which appears upon
+ * completion of a game. Shows various stats.
+ */
 class GameEndingActivity : AppCompatActivity() {
 
     private var incorrectSongs: ArrayList<String>? = arrayListOf("Default song")

diff --git a/app/src/main/java/ch/sdp/vibester/activity/IncorrectSongsActivity.kt b/app/src/main/java/ch/sdp/vibester/activity/IncorrectSongsActivity.kt
@@ -9,7 +9,10 @@ import android.widget.LinearLayout.LayoutParams
 import android.widget.TextView
 import androidx.appcompat.app.AppCompatActivity
 import ch.sdp.vibester.R
-
+/*
+ * A class representing the activity which shows the list of songs the user
+ * guessed incorrectly during the game.
+ */
 class IncorrectSongsActivity : AppCompatActivity() {
     private var incorrectSongs: ArrayList<String>? = ArrayList(15) //15 being max incorrect shown
     private var nbIncorrect: Int = 0
@@ -28,6 +31,10 @@ class IncorrectSongsActivity : AppCompatActivity() {
         generateTextView(nbIncorrect, incorrectSongs, layout)
     }
 
+    /*
+     * A function user to generate and initialize a TextView for a nbIncorrect number of times.
+     * Adds each TextView to the LinearLayout provided in the arguments.
+     */
     private fun generateTextView(
         nbIncorrect: Int,
         incorrectSongs: ArrayList<String>?,