Merge branch 'master' of https://gitlab.isima.fr/audorival/sokoban

script/display.c

@@ -1,6 +1,6 @@
 /**
  * \file display.c
- *
+ * Fichier contient tout les fonctions pour l'affichage.
  */
 #include "../include/display.h"
 #include "../include/function.h"

script/function.c

@@ -21,9 +21,10 @@
 #include <time.h>
 
 /**
- * \brief Cette fonction permet de creer une liste 2D carre
- * \param N La valeur N est le nombre d'élément dans le tableau.
- * \return Le pointeur du tableau 2D carre de char (1 octet).
+ * \brief Cette fonction permet de creer une liste 2D 
+ * \param x Nombre de ligne.
+ * \param y Nombre de colonne.
+ * \return Le pointeur du tableau 2D de char (1 octet).
  */
 char **creatArea2D (const int x, const int y)
 {
@@ -61,7 +62,7 @@ char **creatArea2D (const int x, const int y)
 /**
  * \brief Cette fontion permet de liberer l'espace tu tableau 2D de char.
  * \param tab Le tableau 2D.
- * \param N Le nombre d'éléments.
+ * \param x Le nombre de ligne.
  * \return Void.
  */
 void free2D (char **tab, int x)
@@ -86,8 +87,8 @@ void free2D (char **tab, int x)
  * joueur, 2 si c'est une boite mais qu'on peux la pousser ,3 si le joueur
  * pousse une boite sur un point d'interer, 4 si le joueur bouge sur un point
  * d'interer, 5 si le joueur peux pousser une boite mais le joueur se place sur
- * un point d'interer et 6 si le joeuur pousse une boite sur un point d'interer
- * et que le joueu est aussi sur un point d'interer.
+ * un point d'interer et 6 si le joueur pousse une boite sur un point d'interer
+ * et que le joueur est aussi sur un point d'interer. 7 si valueOfNCase est un bouton.
  */
 char canIGoDirection (char valueOfNCase, char valueOfNPlusOneCase)
 {
@@ -448,7 +449,7 @@ bool isWin (char **tab2d, vect *targets, int nbr_targets)
 /**
  * \brief La fonction renvois si la partie est perdante.
  * \param tab2d Le tableau 2d carre du plateau de jeu.
- * \param N Le nombre d'éléments dans le tab2d.
+ * \param N Le nombre d'éléments dans le tab2d. (zone de jeu est carré)
  * \return True si c'est perdu, false si c'est pas perdu a cette instant.
  *
  */

script/main.c

@@ -44,7 +44,7 @@ int main ()
     nullScore(&score_user);
     SDL_RenderClear(display_user.renderer);
 
-
+    // Loop pour le jeu entier menu et les jeux.
     while(output != 0)
     {
         SDL_RenderClear(display_user.renderer);

script/read.c

@@ -70,6 +70,11 @@ vect *fileToTab2D (const char *name_file, char **tab,
     return targets;
 }
 
+/**
+* \brief La fonction permet de compter le nombre de maps custom dans le fichier des maps.
+* \param name_directory Le nom du dossier contenant les maps.
+* return Le nombre de maps custom.
+*/
 int countCustomMaps(char *name_directory)
 {
     int nbr = 0;
@@ -80,13 +85,20 @@ int countCustomMaps(char *name_directory)
     {
         nbr++;
         sprintf(name_map, "%s/custom_%d.txt",name_directory ,nbr);
+        if(file != NULL) fclose(file);
         file = fopen(name_map, "r");
     }
 
     return nbr;
 }
 
-
+/**
+* \brief La fonction permet de creer la zone de jeu du menu en fonction
+* du nombre de maps custom.
+* \param name_directory Le nom du dossier contenant les maps.
+* \param size La taille de la zone de jeu.
+* \param pos_player La position du joueur dans le menu.
+*/
 char ** generatorMenu(char *name_directory, vect *size, vect *pos_player)
 {
     pos_player->x = 4;