Diff: Score/Score.h

Revision:

16:4e49f5cb972e

Parent:

12:71683453f66a

Child:

17:5d8ff39a0e49

--- a/Score/Score.h	Sat Apr 20 11:53:09 2019 +0000
+++ b/Score/Score.h	Sat Apr 20 15:20:43 2019 +0000
@@ -9,21 +9,94 @@
 #include "Charmander.h"
 #include "Bulbasaur.h"
 
+/** Score Class
+* @author Yiu Fai Kwok, University of Leeds
+* @version 1.0
+* @brief Score class containing all in-game background music files 
+* @date 20/04/2019
+*/ 
+
 class Score
 {
 public:
+    
+    /** Constructor */
     Score();
+    /** Deconstructor */
     ~Score();
+    
+    /**
+     * @brief Title screen music
+     * @details Background music played during title screen
+     */
     void title_music(Gamepad &pad);
+    
+    /**
+     * @brief Level up music
+     * @details Background music played when player advance in level or year
+     */
     void level_up(Gamepad &pad);
+    
+    /**
+     * @brief Congratulation music
+     * @details Background music played when player succesfully completed a mission
+     */
     void congrats(Gamepad &pad);
+    
+    /**
+     * @brief Coin music
+     * @details Background music played when player successfully collected a coin in Game 1
+     */
     void coin(Gamepad &pad);
+    
+    /**
+     * @brief Evolution animation and music
+     * @param cha
+     * @param year
+     * @details Background music played when player's character enters evolution, dependent on character selected (cha) and year of which player is currently in (year), initiate animation for evolution.
+     */
     void evolution_music(Gamepad &pad, N5110 &lcd, int cha, int year);
+    
+    /**
+     * @brief Congratulation music for evolution
+     * @details Background music played when player's character succesfully evolves, draw sprite of the evolved character
+     */
     void congrats(Gamepad &pad, N5110 &lcd, int cha, int year);
+    
+    /**
+     * @brief Draw sprite of pokemon
+     * @param cha
+     * @param year
+     * @param x
+     * @param y
+     * @details Draw sprite of character depending on character selected (cha) and the year at which the player is in (year). Location of the sprite is determined by x and y to generate the moving name title.
+     */
     void draw(N5110 &lcd, int cha, int year, int x, int y);
+    
+    /**
+     * @brief Draw sprite of evolved pokemon
+     * @param cha
+     * @param year
+     * @details Draw sprite of evolved character according to year (year) and character selected (cha)
+     */
     void draw_cong(N5110 &lcd, int cha, int year);
+    
+    /**
+     * @brief Music for winning
+     * @details Background music played when player wins a mini game
+     */
     void win(Gamepad &pad);
+    
+    /**
+     * @brief Music for EXAM introduction
+     * @details Background music played when player enters the EXAM
+     */
     void exam_intro(Gamepad &pad);
+    
+    /**
+     * @brief Music for EXAM running in parallel to the exam
+     * @details Background music played during the EXAM
+     */
     void gym(Gamepad &pad, bool state);
     
 private: