doc goodPixelManager.h

headers/pixelManager/goodPixelManager.h

@@ -3,17 +3,55 @@
 
 #include "pixelManager/pixelManager.h"
 
+
+/*!
+ * @class GoodPixelManager
+ * @brief Extension of the PixelManager class, which override
+ * the draw methods to use sprites instead of shapes
+ */
 class GoodPixelManager : public PixelManager{
 
+	/*!
+	* @brief loads sprites in parallel using multiple threads
+ 	* @param[in] vec : We take his ownership, so
+	* @fn void loadSprites();
+	*/
 	void loadSprites(vector<Task>& tasks) override;
 
+	/*!
+	* @brief sprite of the player
+	*/
 	MySprite player;
+
+	/*!
+	* @brief sprite of the first invader
+	*/
 	MySprite invaderA;
+
+	/*!
+	* @brief sprite of the second invader
+	*/
 	MySprite invaderB;
+
+	/*!
+	* @brief sprite of the third invader
+	*/
 	MySprite invaderC;
+
+	/*!
+	* @brief sprite of the missile
+	*/
 	MySprite missile;
+
+	/*!
+	* @brief sprite of the torpedo
+	*/
 	MySprite torpedo;
 public:
+
+	/*!
+	* @brief constructor
+	*/
 	GoodPixelManager(MinGL& win);
 };