Diff: lib/Barrel/Barrel.h

Revision:

18:80c47cfe9802

Parent:

11:b288d01533cc

Child:

19:8400ecdb69e9

--- a/lib/Barrel/Barrel.h	Wed May 08 22:17:24 2019 +0000
+++ b/lib/Barrel/Barrel.h	Wed May 08 22:35:48 2019 +0000
@@ -1,9 +1,3 @@
-/*
-ELEC2645 Project
-Barrel.h
-Class file for Barrel in Donkey Kong game.
-*/
-
 #ifndef BARREL_H
 #define BARREL_H
 
@@ -12,25 +6,45 @@
 #include "Barrel.h"
 #include "Donkey.h"
 
-    extern int barrel_x;
-    extern int barrel_y;
-    extern int barrel_speed;
-    extern int barrel_min;
-    extern int barrel_max;
-    extern float barrel_time;
-    extern int running;
+/** External variables used inside and out of the class. */
+extern int barrel_x;
+extern int barrel_y;
+extern int barrel_speed;
+extern int barrel_min;
+extern int barrel_max;
+extern float barrel_time;
+extern int running;
+
+/** Barrel Class
+*@brief This class is for spawning the barrel, it will float down the screen. Collision with the player will cause gameover.
+*@author Kern Fowler
+*@version 1.0
+*@date May 2019
+*/
     
-class Barrel
-{
-
-    public:
+class Barrel { 
 
-
-    Barrel();
+public:
+/** Barrel Constructor 
+@brief Builds my default Barrel contructor.
+@details This does not have any setup. 
+*/
+Barrel();
+/** Barrel Destructor 
+@brief Builds my default Barrel dentructor.
+@details This does not have any setup. 
+*/
+~Barrel();
+// Mutators
 
-    ~Barrel();
-    void barrel_drop(Gamepad &pad, N5110 &lcd, Donkey &dky);
+/** 
+*@brief Spawns the barrel
+*@param pad The Gamepad class is used.
+*@param lcd The N5110 class is used.
+*@param dky The Donkey class is used.
+*@details Spawns a barrel at a random x location, then slowly falls down screen. When reaches bottom it restarts. If collision with player leads to gameover.
+*/
+void barrel_drop(Gamepad &pad, N5110 &lcd, Donkey &dky);
 };
 
-
 #endif
\ No newline at end of file