From 8aea8ba0f9ad34c14c37424f3d7b70e2ae8b9836 Mon Sep 17 00:00:00 2001 From: SIMAILA Djalim Date: Tue, 11 Jan 2022 14:31:07 +0100 Subject: [PATCH] Doc stuff again --- headers/pixelManager/goodPixelManager.h | 25 +++++++++++++++++++------ headers/pixelManager/pixelManager.h | 10 ++++++---- 2 files changed, 25 insertions(+), 10 deletions(-) diff --git a/headers/pixelManager/goodPixelManager.h b/headers/pixelManager/goodPixelManager.h index 34b66b3..7223dc8 100644 --- a/headers/pixelManager/goodPixelManager.h +++ b/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& 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); }; diff --git a/headers/pixelManager/pixelManager.h b/headers/pixelManager/pixelManager.h index 06894b7..cc56932 100644 --- a/headers/pixelManager/pixelManager.h +++ b/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& tasks); - /*! * @brief sprite of the logo of the game */