Diff: Fire/Fire.h

Revision:

24:c7df5aa476a9

Parent:

21:20478f086bc2

Child:

25:aa145767fda5

--- a/Fire/Fire.h	Mon Apr 22 16:33:29 2019 +0000
+++ b/Fire/Fire.h	Wed Apr 24 17:38:41 2019 +0000
@@ -1,47 +1,37 @@
-/** Fire Class
-* @brief Generates a fire ball that will end the game if the skateboarder touches it * @author Lewis Wooltorton
-* @date April 2019
-*/
-
 #ifndef FIRE_H
 #define FIRE_H
 
 #include "mbed.h"
 
+/** Fire Class
+* @brief Generates a fire ball that will end the game if the skateboarder touches it 
+* @author Lewis Wooltorton
+* @date April 2019
+*/
+
 class Fire {
  public:
-  // Constructor and destructor.
-  /**
-  * @brief Constructor @details Non user specified.
-  */
+  /** Constructor, non user specified.*/
   Fire();
-  /**
-  * @brief Destructor @details Non user specified.
-  */
+  /** Destructor non user specified.*/
   ~Fire();
   
   // Mutators.
-  /** 
-  * @breif Initialises Fire object. 
-  */
+  /** Initialises Fire object. */
   void init();
 
   // Accessors
-  /**
-  * @breif Gets the sprite.
+  /** Gets the sprite.
   * @returns The Fire sprite (an integer array)
   */
   int * get_fire_sprite();
-  /**
-  * @breif Gets the X coordinate. 
+  /** 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.
-  */
+  /** Generates Fire parameters @details Increments Fire x coordinate and toggles fire sprite.*/
   void generate_fire();
 
  private: