mis en place la PR de simon sur les couleurs

src/Core/GameParameters.h

@@ -10,20 +10,20 @@
  */
 class GameParameters {
     private:
-        Gamemode gamemode; // the current gamemode
-        Player controls; // the player's controls
-        int clearedLines; // the number of cleared lines
-        int level; // the current level
+        Gamemode gamemode;   // the current gamemode
+        Player controls;     // the player's controls
+        int clearedLines;    // the number of cleared lines
+        int level;           // the current level
         int nextQueueLength; // the number of pieces visibles in the next queue
-        bool boneBlocks; // wheter all blocks are bone blocks
-        int gravity; // the gravity at which pieces drop
-        int lockDelay; // the time before the piece lock in place
+        bool boneBlocks;     // wheter all blocks are bone blocks
+        int gravity;         // the gravity at which pieces drop
+        int lockDelay;       // the time before the piece lock in place
         int forcedLockDelay; // the forced time before the piece lock in place
-        int ARE; // the time before the next piece spawn
-        int lineARE; // the time before the next piece spawn, after clearing a line
-        int DAS; // the time before the piece repeats moving
-        int ARR; // the rate at which the piece repeats moving
-        int SDR; // the rate at which the piece soft drops
+        int ARE;             // the time before the next piece spawn
+        int lineARE;         // the time before the next piece spawn, after clearing a line
+        int DAS;             // the time before the piece repeats moving
+        int ARR;             // the rate at which the piece repeats moving
+        int SDR;             // the rate at which the piece soft drops
 
     public:
         /**
@@ -32,12 +32,13 @@ class GameParameters {
         GameParameters(Gamemode gamemode, const Player& controls);
 
         /**
-         * Count the newly cleared lines and update level and stats if needed
+         * Counts the newly cleared lines and update level and stats if needed
          */
         void clearLines(int lineNumber);
 
         /**
-         * Returns wheter the game ended
+         * Checks if the game ended based on the current states and time passed, accorind to the gamemode
+         * @return If the player has won
          */
         bool hasWon(int framesPassed);
 
@@ -49,17 +50,17 @@ class GameParameters {
 
     public:
         /**
-         * Returns the current number of cleared line
+         * @return The current number of cleared line
          */
         int getClearedLines();
 
         /**
-         * Returns the current level
+         * @return The current level
          */
         int getLevel();
 
         /**
-         * Returns the length of the next queue
+         * @return The length of the next queue
          */
         int getNextQueueLength();
 
@@ -69,42 +70,42 @@ class GameParameters {
         bool getBoneBlocks();
         
         /**
-         * Returns the current gravity for a 20-line high board
+         * @return The current gravity for a 20-line high board
          */
         int getGravity();
 
         /**
-         * Returns the current lock delay
+         * @return The current lock delay
          */
         int getLockDelay();
 
         /**
-         * Returns the current forced lock delay
+         * @return The current forced lock delay
          */
         int getForcedLockDelay();
 
         /**
-         * Returns the current ARE
+         * @return The current ARE
          */
         int getARE();
 
         /**
-         * Returns the current line ARE
+         * @return The current line ARE
          */
         int getLineARE();
         
         /**
-         * Returns the current DAS
+         * @return The current DAS
          */
         int getDAS();
 
         /**
-         * Returns the current ARR
+         * @return The current ARR
          */
         int getARR();
 
         /**
-         * Returns the current SDR
+         * @return The current SDR
          */
         int getSDR();
 };