ELEC2645 (2019/20) / Mbed 2 deprecated ELEC2645_Project_el19tb

Dependencies:   mbed

Revision:
58:35560ce5eca3
Parent:
57:a6eb3a0e92bc
Child:
59:1eaadf2f8fa4
--- a/Frogger/Frogger.h	Tue May 26 21:09:40 2020 +0000
+++ b/Frogger/Frogger.h	Tue May 26 21:47:35 2020 +0000
@@ -27,6 +27,7 @@
 class Frogger
 {
     public: 
+    
         /** @param frog object that frogger class keeps track of 
          */
         Frog *frog; // one frog object
@@ -108,6 +109,7 @@
         int turtle_state;
         
     public:
+    
         /** @param local hardware object, used for sounds, LED, and button controls etc.
          */
         Gamepad gamepad;
@@ -118,43 +120,110 @@
         
         /** @param size of the game grid
          */
-        int grid; // size of one game unit
+        int grid; 
+        
+        /** @param size of the game grid
+         */
         int row_number;
-        int grid_width; // screen width in grid units
+        
+        /** @param size of the lcd width in grid units
+         */
+        int grid_width;
+        
+        /** @param size of the lcd width
+         */
         int lcd_w;
+        
+        /** @param size of the lcd height
+         */
         int lcd_h;
 
     public:
 
-        // Level One Car objects
+        /** @param level one row 1 vehicle objects
+         */        
         Object car_row_one_one[3]; 
+        
+        /** @param level one row 2 vehicle objects
+         */  
         Object car_row_two_one[2];
+        
+        /** @param level one row 3 vehicle objects
+         */  
         Object car_row_three_one[3];
+        
+        /** @param level one row 4 vehicle objects
+         */  
         Object car_row_four_one[4];
 
-        // Level One Log objects
-        Object row_one_log[3]; // large sized
-        Object row_two_log[2]; // medium sized
-        Object row_three_log[3]; // large sized
+        /** @param level one row 7 log objects
+         */
+        Object row_one_log[3];
+         
+        /** @param level one row 8 log objects
+         */
+        Object row_two_log[2]; 
+        
+        /** @param level one row 9 log objects
+         */
+        Object row_three_log[3]; 
+
 
-        // Level two Car Objects
+        /** @param level two row 1 vehicle objects
+         */      
         Object car_row_one_two[4];
+        
+        /** @param level two row 2 vehicle objects
+         */ 
         Object car_row_two_two[3];
+        
+        /** @param level two row 3 vehicle objects
+         */ 
         Object car_row_three_two[4];
+        
+        /** @param level two row 4 vehicle objects
+         */ 
         Object car_row_four_two[3];
 
-        // level two log objects
+        /** @param level 2 row 7 log objects
+         */
         Object level_row_one[2];
+        
+        /** @param level 2 row 7 log objects
+         */
         Object level_row_two[2];
+        
+        /** @param level 2 row 7 log objects
+         */
         Object level_row_three[3];
 
-        //BONUS ROUND
+
+        /** @param bonus level row 1 vehicle objects
+         */
         Object bonus_row_one[4];
+        
+        /** @param bonus level row 2 vehicle objects
+         */
         Object bonus_row_two[3];
+        
+        /** @param bonus level row 3 vehicle objects
+         */
         Object bonus_row_three[4];
+        
+        /** @param bonus level row 4 vehicle objects
+         */
         Object bonus_row_four[3];
+        
+        /** @param bonus level row 6 vehicle objects
+         */
         Object bonus_row_six[2];
+        
+        /** @param bonus level row 7 vehicle objects
+         */
         Object bonus_row_seven[2];
+        
+        /** @param bonus level row 8 vehicle objects
+         */
         Object bonus_row_eight[3];
             
     public: