ELEC2645 (2019/20) / Mbed 2 deprecated ELEC2645_Project_el19tb

Dependencies:   mbed

Revision:
59:1eaadf2f8fa4
Parent:
58:35560ce5eca3
Child:
60:e1ac7fa5cf17
--- a/Frogger/Frogger.h	Tue May 26 21:47:35 2020 +0000
+++ b/Frogger/Frogger.h	Tue May 26 21:50:52 2020 +0000
@@ -45,184 +45,184 @@
         
     public:
     
-        /** @param current level of the game (starts from 1)
+        /** @brief current level of the game (starts from 1)
          */
         int current_level;
         
-        /** @param current state of the frog, used to draw the animation of the frog
+        /** @brief current state of the frog, used to draw the animation of the frog
          */
         int state_frog;
         
-        /** @param if the frog is in the water level, it can die now if it is
+        /** @brief if the frog is in the water level, it can die now if it is
          * not on the log
          */
         bool frogDie;
         
-        /** @param store the x position of the goal post
+        /** @brief store the x position of the goal post
          */
         int goal_post_xpos;
         
-        /** @param user is playing the game right now
+        /** @brief user is playing the game right now
          */
         bool play_game;
         
-        /** @param user is currently in the main menu
+        /** @brief user is currently in the main menu
          */
         bool introScreen;
         
-        /** @param user is currently reading the tutorial manual
+        /** @brief user is currently reading the tutorial manual
          */
         bool tutorial;
         
-        /** @param user is currently reading the settings
+        /** @brief user is currently reading the settings
          */
         bool settings;
         
-        /** @param if this on, then there exists an end post 
+        /** @brief if this on, then there exists an end post 
          */
         bool end_post;
         
-        /** @param frog is successful in current level
+        /** @brief frog is successful in current level
          */
         bool nextLevel;
         
-        /** @param informs if the frog reached end post
+        /** @brief informs if the frog reached end post
          */
         bool next_goal;
         
-        /** @param this means that bonus round is screen is on
+        /** @brief this means that bonus round is screen is on
          */
         bool bonus_round;
         
-        /** @param y coord (in rows) value of the water level
+        /** @brief y coord (in rows) value of the water level
          */
         float water_level;
          
-        /** @param if the frog collides with log object and is above second
+        /** @brief if the frog collides with log object and is above second
          * safety lane, it is attached to the object (going same speed)
          */
         bool frogOnLog; 
         
-        /** @param current state of the turtles, this is used to draw the animation
+        /** @brief current state of the turtles, this is used to draw the animation
          * of the turtle in level 2
          */
         int turtle_state;
         
     public:
     
-        /** @param local hardware object, used for sounds, LED, and button controls etc.
+        /** @brief local hardware object, used for sounds, LED, and button controls etc.
          */
         Gamepad gamepad;
         
-        /** @param class object that keeps track of the current pointer position, current page
+        /** @brief class object that keeps track of the current pointer position, current page
          */
         IntroScreen intro;
         
-        /** @param size of the game grid
+        /** @brief size of the game grid
          */
         int grid; 
         
-        /** @param size of the game grid
+        /** @brief size of the game grid
          */
         int row_number;
         
-        /** @param size of the lcd width in grid units
+        /** @brief size of the lcd width in grid units
          */
         int grid_width;
         
-        /** @param size of the lcd width
+        /** @brief size of the lcd width
          */
         int lcd_w;
         
-        /** @param size of the lcd height
+        /** @brief size of the lcd height
          */
         int lcd_h;
 
     public:
 
-        /** @param level one row 1 vehicle objects
+        /** @brief level one row 1 vehicle objects
          */        
         Object car_row_one_one[3]; 
         
-        /** @param level one row 2 vehicle objects
+        /** @brief level one row 2 vehicle objects
          */  
         Object car_row_two_one[2];
         
-        /** @param level one row 3 vehicle objects
+        /** @brief level one row 3 vehicle objects
          */  
         Object car_row_three_one[3];
         
-        /** @param level one row 4 vehicle objects
+        /** @brief level one row 4 vehicle objects
          */  
         Object car_row_four_one[4];
 
-        /** @param level one row 7 log objects
+        /** @brief level one row 7 log objects
          */
         Object row_one_log[3];
          
-        /** @param level one row 8 log objects
+        /** @brief level one row 8 log objects
          */
         Object row_two_log[2]; 
         
-        /** @param level one row 9 log objects
+        /** @brief level one row 9 log objects
          */
         Object row_three_log[3]; 
 
 
-        /** @param level two row 1 vehicle objects
+        /** @brief level two row 1 vehicle objects
          */      
         Object car_row_one_two[4];
         
-        /** @param level two row 2 vehicle objects
+        /** @brief level two row 2 vehicle objects
          */ 
         Object car_row_two_two[3];
         
-        /** @param level two row 3 vehicle objects
+        /** @brief level two row 3 vehicle objects
          */ 
         Object car_row_three_two[4];
         
-        /** @param level two row 4 vehicle objects
+        /** @brief level two row 4 vehicle objects
          */ 
         Object car_row_four_two[3];
 
-        /** @param level 2 row 7 log objects
+        /** @brief level 2 row 7 log objects
          */
         Object level_row_one[2];
         
-        /** @param level 2 row 7 log objects
+        /** @brief level 2 row 7 log objects
          */
         Object level_row_two[2];
         
-        /** @param level 2 row 7 log objects
+        /** @brief level 2 row 7 log objects
          */
         Object level_row_three[3];
 
 
-        /** @param bonus level row 1 vehicle objects
+        /** @brief bonus level row 1 vehicle objects
          */
         Object bonus_row_one[4];
         
-        /** @param bonus level row 2 vehicle objects
+        /** @brief bonus level row 2 vehicle objects
          */
         Object bonus_row_two[3];
         
-        /** @param bonus level row 3 vehicle objects
+        /** @brief bonus level row 3 vehicle objects
          */
         Object bonus_row_three[4];
         
-        /** @param bonus level row 4 vehicle objects
+        /** @brief bonus level row 4 vehicle objects
          */
         Object bonus_row_four[3];
         
-        /** @param bonus level row 6 vehicle objects
+        /** @brief bonus level row 6 vehicle objects
          */
         Object bonus_row_six[2];
         
-        /** @param bonus level row 7 vehicle objects
+        /** @brief bonus level row 7 vehicle objects
          */
         Object bonus_row_seven[2];
         
-        /** @param bonus level row 8 vehicle objects
+        /** @brief bonus level row 8 vehicle objects
          */
         Object bonus_row_eight[3];