Revision 22:9e9685856ce1, committed 2019-05-09

Comitter:

el17mcd

Date:

Thu May 09 13:45:05 2019 +0000

Parent:

21:44e87d88afe2

Commit message:

I have read and understood the university's guidelines on plagiarism.; I here by declare that all work is my own and no one else's.;

Changed in this revision

--- a/Menus/Menus.cpp	Thu May 09 13:10:16 2019 +0000
+++ b/Menus/Menus.cpp	Thu May 09 13:45:05 2019 +0000
@@ -49,7 +49,7 @@
   }
 }
 
-void Menus::_main_menu_controls(N5110 &lcd, Gamepad &pad, Scores &scores)
+void Menus::_main_menu_controls(N5110 &lcd, Gamepad &pad, Scores &scores)   
 {
   pad.check_event(Gamepad::BACK_PRESSED);
   if (pad.check_event(Gamepad::X_PRESSED) == true) { 
@@ -63,7 +63,7 @@
   }
 }
 
-void Menus::_start_up_visuals(Graphics &graphics, N5110 &lcd, Gamepad &pad)
+void Menus::_start_up_visuals(Graphics &graphics, N5110 &lcd, Gamepad &pad) // Draw start up visuals
 {
   if (_counter >= 0) {
     graphics.start_up(1, pad);
@@ -84,7 +84,7 @@
   _counter++;
 }
 
-void Menus::_read_inputs(Gamepad &pad)
+void Menus::_read_inputs(Gamepad &pad)   // Clear the triggers
 {
   pad.check_event(Gamepad::Y_PRESSED);
   pad.check_event(Gamepad::X_PRESSED);
@@ -144,7 +144,7 @@
     } else if (pad.check_event(Gamepad::B_PRESSED) == true) {
       lcd.setBrightness(pad.read_pot()); 
     } else { 
-      _counter = -1; 
+      _counter = -1; //reset counter
     }        
   }
   char buffer[14]; 

--- a/Scores/Scores.cpp	Thu May 09 13:10:16 2019 +0000
+++ b/Scores/Scores.cpp	Thu May 09 13:45:05 2019 +0000
@@ -24,7 +24,7 @@
   return new_score;
 }
 
-void Scores::display_score(float current, N5110 &lcd)
+void Scores::display_score(float current, N5110 &lcd)  // Display the current games end score
 {
   char buffer[14]; 
   sprintf(buffer, "%.0f", current); 
@@ -32,7 +32,7 @@
   lcd.printString(buffer, 60, 4);
 }  
 
-void Scores::display_top_scores(N5110 &lcd)
+void Scores::display_top_scores(N5110 &lcd) // Displays high scores 
 {
   char buffer[14]; 
   sprintf(buffer, "%.0f", _top_three[0]); 

--- a/Tank/Tank.h	Thu May 09 13:10:16 2019 +0000
+++ b/Tank/Tank.h	Thu May 09 13:45:05 2019 +0000
@@ -120,7 +120,7 @@
 
   //Member Methods
   /**
-  * @brief Moves the tank left or right depending on the whether the input is negative or posititive.
+  * @brief Moves the tank left or right depending on the whether the input is negative or positive.
   * @param d @details The direction the tank should move
   */
   void move_position(int d);

--- a/TanksEngine/TanksEngine.h	Thu May 09 13:10:16 2019 +0000
+++ b/TanksEngine/TanksEngine.h	Thu May 09 13:45:05 2019 +0000
@@ -75,17 +75,17 @@
   ~TanksEngine(); 
   
   /**
-  * @brief Resets member variables to their default values from previous games and sets the values specified in setting. 
-  * @param &menus * @details The menus object from Menus class.
+  * @brief Resets member variables from previous games to their default values and sets the values specified in setting. 
+  * @param menus * @details The menus object from Menus class.
   */   
   void initgame(Menus &menus);
   /**
   * @brief Runs the main gameloop updating the game as the player inputs controls and updating display based on game events. 
-  * @param &graphics * @details The graphics object from Graphics class.
-  * @param &lcd * @details The lcd object from N5110 class.
-  * @param &pad * @details The pad object from Gamepad class.
-  * @param &menus * @details The menus object from Menus class.
-  * @param &scores * @details The scores object from Scores class.
+  * @param graphics * @details The graphics object from Graphics class.
+  * @param lcd * @details The lcd object from N5110 class.
+  * @param pad * @details The pad object from Gamepad class.
+  * @param menus * @details The menus object from Menus class.
+  * @param scores * @details The scores object from Scores class.
   */  
   void game_loop(Graphics &graphics, N5110 &lcd, Gamepad &pad,
                  Menus &menus, Scores &scores);