Diff: Fire/Fire.h

Revision:

21:20478f086bc2

Parent:

18:304700b5d8f8

Child:

24:c7df5aa476a9

--- a/Fire/Fire.h	Tue Apr 16 19:19:43 2019 +0000
+++ b/Fire/Fire.h	Sat Apr 20 14:46:50 2019 +0000
@@ -10,13 +10,39 @@
 
 class Fire {
  public:
+  // Constructor and destructor.
+  /**
+  * @brief Constructor @details Non user specified.
+  */
   Fire();
+  /**
+  * @brief Destructor @details Non user specified.
+  */
   ~Fire();
   
+  // Mutators.
+  /** 
+  * @breif Initialises Fire object. 
+  */
   void init();
-  void update_fire();
+
+  // Accessors
+  /**
+  * @breif Gets the sprite.
+  * @returns The Fire sprite (an integer array)
+  */
   int * get_fire_sprite();
+  /**
+  * @breif Gets the X coordinate. 
+  * @returns The X coordinate of the Fire
+  */
   int get_fire_x();
+  
+  // Member methods.
+  /**
+  * @breif Generates Fire parameters @details Increments Fire x coordinate and toggles fire sprite.
+  */
+  void generate_fire();
 
  private:
   int _x;