Added documentation

Author: jcalvarezj

Collideable.hpp

@@ -1,3 +1,8 @@
+/*
+ * Snake game program using the SDL library
+ *
+ * @author J. Alvarez
+ */
 #include "SDL2/SDL.h"
 #include "Screen.hpp"
 #include "Drawable.hpp"
@@ -13,11 +18,21 @@ namespace SnakeGame {
  * are in the same position a collision is assumed
  */
 struct Collideable: Drawable {
+	/**
+	 * Creates an Collideable instance with a position
+	 * @param x X position of this object
+	 * @param y Y position of this object
+	 */
 	Collideable(int x, int y);
 
+	/**
+	 * Validates whether there is a collision between this object and another
+	 * @param other The other object to check whether collision occurs
+	 * @return boolean indicating whether collision occurs
+	 */
 	bool collidesWith(Collideable & other);
 };
 
 } // namespace SnakeGame
 
-#endif // COLLIDEABLE_HPP
+#endif // COLLIDEABLE_HPP

Drawable.hpp

@@ -1,3 +1,8 @@
+/*
+ * Snake game program using the SDL library
+ *
+ * @author J. Alvarez
+ */
 #include "SDL2/SDL.h"
 #include "Screen.hpp"
 
@@ -13,8 +18,17 @@ struct Drawable {
 	int m_x;
 	int m_y;	
 
+	/**
+	 * Initialices Drawable object with a position
+	 * @param x X position of this object
+	 * @param y Y position of this object
+	 */
 	Drawable(int x, int y): m_x(x), m_y(y) {}
 
+	/**
+	 * Draws on screen this object
+	 * @screen Reference to screen to draw on
+	 */
 	virtual void draw(Screen & screen) = 0;
 };
 

Food.hpp

@@ -1,3 +1,8 @@
+/*
+ * Snake game program using the SDL library
+ *
+ * @author J. Alvarez
+ */
 #include "Collideable.hpp"
 #include "Screen.hpp"
 #include "SDL2/SDL.h"
@@ -19,11 +24,17 @@ struct Food: Collideable {
 	static const unsigned int S_FOOD_WIDTH;
 	static const int S_VALUE;
 
+	/**
+	 * Default constructor for Food instances
+	 */
 	Food();
 
+	/**
+	 * @see Drawable#draw
+	 */
 	void draw(Screen & screen);
 };
 
 } // namespace SnakeGame
 
-#endif // FOOD_HPP
+#endif // FOOD_HPP

Screen.cpp

@@ -1,3 +1,8 @@
+/*
+ * Snake game program using the SDL library
+ *
+ * @author J. Alvarez
+ */
 #include "Screen.hpp"
 #include "SDL2/SDL.h"
 #include <iostream>

Screen.hpp

@@ -1,3 +1,8 @@
+/*
+ * Snake game program using the SDL library
+ *
+ * @author J. Alvarez
+ */
 #include "SDL2/SDL.h"
 #include "SDL2/SDL_ttf.h"
 #include <string>

Section.hpp

@@ -1,3 +1,8 @@
+/*
+ * Snake game program using the SDL library
+ *
+ * @author J. Alvarez
+ */
 #include "Collideable.hpp"
 #include "Screen.hpp"
 #include "SDL2/SDL.h"
@@ -14,11 +19,37 @@ namespace SnakeGame {
 struct Section: Collideable {
 	static const unsigned int S_SECTION_WIDTH;
 
+	/**
+	 * Default constructor for creating Section instances
+	 */
 	Section();
+
+	/**
+	 * @see Collideable#Collideable(int, int)
+	 */
 	Section(int x, int y);
+
+	/**
+	 * @see Drawable#draw
+	 */
 	void draw(Screen & screen);
+
+	/**
+	 * Moves the section to another position according to a direction
+	 * @param direction The direction to move this section to
+	 */
 	void move(int direction);
+
+	/**
+	 * Returns the direction value from this Section to another
+	 * @other The other section to calculate direction
+	 * @return integer indicating direction from Snake::Direction
+	 */
 	int calculateDirection(Section & other);
+
+	/**
+	 * Show information about this instance on screen
+	 */
 	void toString();  // TODO Remove
 };
 

Snake.hpp

@@ -30,21 +30,73 @@ struct Snake {
 
 	std::vector<Section *> m_sections;
 
+	/**
+	 * Default constructor of Snake to create instances
+	 */
 	Snake();
+
+	/**
+	 * Destructor for Snake that cleans up sections
+	 */
 	~Snake();
 
+	/**
+	 * @see Drawable#draw
+	 */
 	void draw(Screen & screen);
+
+	/**
+	 * Updates the direction of the snake
+	 * @direction The direction of the snake according to Snake::Direction
+	 */
 	void updateDirection(int direction);
+
+	/**
+	 * Moves the snake, which implies moving all its sections
+	 * @return true if movement is within Screen's area, false otherwise
+	 */
 	bool move();
+
+	/**
+	 * Removes one life from the snake
+	 */
 	void die();
+
+	/**
+	 * Resets snake to its initial state (except for lives)
+	 */
 	void reset();
+
+	/**
+	 * Checks whether the snake (it's head section) collides with another object
+	 */
 	bool collidesWith(Collideable & object);
+
+	/**
+	 * Adds a new section to the end of the snake
+	 */
 	void addSection();
+
+	/**
+	 * Show information about this instance on screen
+	 */
 	void toString();  // TODO Remove . For debugging purposes
 
 private:
+	/**
+	 * Frees memory from snake's sections
+	 */
 	void freeSections();
+
+	/**
+	 * Resets the snake's sections to the initial state (initial number and
+	 * position)
+	 */
 	void resetSections();
+
+	/**
+	 * Resets the snake's direction to the initial direction
+	 */
 	void resetDirection();
 };
 

Wall.hpp

@@ -18,11 +18,17 @@ struct Wall: Collideable {
 
 	static const unsigned int S_WALL_WIDTH;
 
+	/**
+	 * @see Collideable#Collideable(int, int)
+	 */
 	Wall(int x, int y);
 
+	/**
+	 * @see Drawable#draw
+	 */
 	void draw(Screen & screen);
 };
 
 } // namespace SnakeGame
 
-#endif // WALL_HPP
+#endif // WALL_HPP

main.cpp

@@ -1,5 +1,6 @@
 /*
- * 
+ * Snake game program using the SDL library
+ *
  * @author J. Alvarez
  */
 #include <iostream>