Doc stuff again

headers/pixelManager/goodPixelManager.h

@@ -1,3 +1,14 @@
+/*!
+ *
+ * @file    goodPixelManager.h
+ * @author  RUBINI Thomas
+ * @date    January 2022
+ * @version 1.0
+ * @brief   Manages screen display with async sprite loading
+ *
+ */
+
+
 #ifndef GUARD_GOODPIXELMANAGER_H
 #define GUARD_GOODPIXELMANAGER_H
 
@@ -13,7 +24,7 @@ class GoodPixelManager : public PixelManager{
 
 	/*!
 	* @brief loads sprites in parallel using multiple threads
- 	* @param[in] vec : We take his ownership, so
+ 	* @param[out] tasks : vectot of task
 	* @fn void loadSprites();
 	*/
 	void loadSprites(vector<Task>& tasks) override;
@@ -24,17 +35,17 @@ class GoodPixelManager : public PixelManager{
 	MySprite player;
 
 	/*!
-	* @brief sprite of the first invader
+	* @brief sprite of the type A invader
 	*/
 	MySprite invaderA;
 
 	/*!
-	* @brief sprite of the second invader
+	* @brief sprite of the type B invader
 	*/
 	MySprite invaderB;
 
 	/*!
-	* @brief sprite of the third invader
+	* @brief sprite of the type B invader
 	*/
 	MySprite invaderC;
 
@@ -50,9 +61,11 @@ class GoodPixelManager : public PixelManager{
 public:
 
 	/*!
-	* @brief constructor
+	* @brief constructor the pixel manager class
+	* @param[in] window : window of the pixel manager
+	* @fn GoodPixelManager(MinGL&);
 	*/
-	GoodPixelManager(MinGL& win);
+	explicit GoodPixelManager(MinGL& window);
 };
 
 

headers/pixelManager/pixelManager.h

@@ -6,7 +6,7 @@
  * @author  FABRE Lucas
  * @date    January 2022
  * @version 1.0
- * @brief    manager
+ * @brief    Manages screen display
  *
  */
 
@@ -46,17 +46,19 @@ typedef nsGui::GlutFont::GlutFonts Font;
 
 class PixelManager{
 public:
-	MinGL& window;
 
+	/*!
+	* @brief display window
+	*/
+	MinGL& window;
 
 	/*!
 	* @brief loads sprites in parallel using multiple threads
- 	* @param[in] vec : We take his ownership, so
+ 	* @param[in] tasks : vectot of task 
 	* @fn void loadSprites();
 	*/
 	 virtual void loadSprites(vector<Task>& tasks);
 
-
 	/*!
 	* @brief sprite of the logo of the game
 	*/