Jwen/scoreboard documentation

app/src/main/java/ch/sdp/vibester/MainActivity.kt

@@ -22,6 +22,8 @@ class MainActivity : AppCompatActivity() {
             startActivity(greetingIntent)
         }
 
+        // button to scoreboard
+        // FIXME: scoreboard enter button need to be move to the welcome screen
         val btnScoreboard = findViewById<Button>(R.id.scoreboardButton)
         val scoreboardIntent = Intent(this, ScoreBoardActivity::class.java)
 

app/src/main/java/ch/sdp/vibester/scoreboard/Player.kt

@@ -1,5 +1,13 @@
 package ch.sdp.vibester.scoreboard
 
+/**
+ * Player class for scoreboard
+ *
+ * @param nik id of the player
+ * @param name name of the player
+ * @param photo profile photo of the player
+ * @param score score of the player
+ */
 data class Player (
     val nik: Int = 0,
     val name: String = "",

app/src/main/java/ch/sdp/vibester/scoreboard/PlayerAdapter.kt

@@ -31,8 +31,15 @@ class PlayerAdapter(playersInit: List<Player>) : RecyclerView.Adapter<PlayerAdap
         notifyDataSetChanged()
     }
 
+    /**
+     * Customer ViewHolder class for PlayerAdapter
+     */
     inner class PlayerViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
 
+        /**
+         * @param player
+         * @param position position of the player
+         */
         fun bind(player: Player, position: Int) {
             val newPosition = position + 1
             itemView.findViewById<TextView>(R.id.tv_position).text = (newPosition).toString()

app/src/main/java/ch/sdp/vibester/scoreboard/ScoreBoardActivity.kt

@@ -16,6 +16,7 @@ class ScoreBoardActivity : AppCompatActivity() {
         loadPlayers()
     }
 
+    // temporary hard-coded list of players for display
     private val players: List<Player> = listOf(
         Player(111, "Brownie","https://images.app.goo.gl/yiPpy7JDRFaZRiAg9", 687 ),
         Player(555, "Cheesecake", "https://images.app.goo.gl/REJnoWR2t3mi2kYJA", 678),