Diff: Map/Map.h

Revision:

11:bb36db678a6d

Parent:

10:da5743dfb137

Child:

12:b3ec47d606a5

--- a/Map/Map.h	Thu May 09 10:53:00 2019 +0000
+++ b/Map/Map.h	Thu May 09 11:24:12 2019 +0000
@@ -20,8 +20,8 @@
 
 
 /** Level Class
+Creates the levels in the Breakout game
 @author Kostadin Chakarov, University of Leeds
-@brief Creates the levels in the Breakout game
 @date April 2019
 */
 
@@ -39,7 +39,7 @@
 class Level1 : public Level
 {
 public:
-    /** Draws the bricks and stores them in the levels vector */
+    /** Draws the bricks for level 1 and stores them in the levels vector */
     virtual void initBricks(Map &map);
 };
 
@@ -47,7 +47,7 @@
 class Level2 : public Level
 {
 public:
-    /** Draws the bricks and stores them in the levels vector */
+    /** Draws the bricks for level 2 and stores them in the levels vector */
     virtual void initBricks(Map &map);
 };
 
@@ -55,7 +55,7 @@
 class Level3 : public Level
 {
 public:
-    /** Draws the bricks and stores them in the levels vector */
+    /** Draws the bricks for level 3 and stores them in the levels vector */
     virtual void initBricks(Map &map);
 };
 
@@ -76,7 +76,7 @@
 /** Forward declaration since needed in PowerUpType struct */
 class PowerUp;
 
-
+/** Struct which contains all the powerup parameters and functions */
 struct PowerUpType {
     int type;       /** Stores the type of the powerup */
     int* sprite;    /** Stores the sprite of the powerup */
@@ -94,7 +94,7 @@
 struct PaddleSizePUpType : public PowerUpType {
     /** Constructor */
     PaddleSizePUpType(int type, int* sprite) : PowerUpType(type, sprite) {}
-    /** Gives the powerup effect to the player */
+    /** Gives the paddle size increase powerup effect to the player */
     virtual void giveBonus(Paddle &paddle, Ball &ball);
 };
 
@@ -102,7 +102,7 @@
 struct PaddleSpeedPUpType : public PowerUpType {
     /** Constructor */
     PaddleSpeedPUpType(int type, int* sprite) : PowerUpType(type, sprite) {}
-    /** Gives the powerup effect to the player */
+    /** Gives the paddle speed incrase powerup effect to the player */
     virtual void giveBonus(Paddle &paddle, Ball &ball);
 };
 
@@ -110,7 +110,7 @@
 struct BallSpeedPUpType : public PowerUpType {
     /** Constructor */
     BallSpeedPUpType(int type, int* sprite) : PowerUpType(type, sprite) {}
-    /** Gives the powerup effect to the player */
+    /** Gives the ball speed decrease powerup effect to the player */
     virtual void giveBonus(Paddle &paddle, Ball &ball);
 };
 
@@ -120,8 +120,8 @@
 
 
 /** PowerUp Class
+Creates the power ups in the Breakout game
 @author Kostadin Chakarov, University of Leeds
-@brief Creates the power ups in the Breakout game
 @date April 2019
 */
 
@@ -154,8 +154,8 @@
 
 
 /** Map Class
+Creates the map and controls collision between objects in the Breakout game
 @author Kostadin Chakarov, University of Leeds
-@brief Creates the map and controls collision between objects in the Breakout game
 @date April 2019
 */