:bulb: Ajout documentation fonctions

wildcard.c

@@ -46,8 +46,6 @@ int wildcard_result(const char* seq) {
     return nbRes;
 }
 
-//Sequence + taille du tableau result + tableau de retour vide
-
 int wildcard(const char* seq, int size, char** result) {
     //Declaration variable
     struct dirent **namelist;
@@ -86,8 +84,6 @@ int wildcard(const char* seq, int size, char** result) {
     return nbRes;
 }
 
-//La position de la valeur à remplacer, le tableau dans lequel il faut remplacer, sa taille, le tableau à insérer, sa taille, la nouvelle taille
-
 char** insert_array(int pos, char** array, int arraysize, char** insert, int insertsize, int* newsize) {
     //Erreur parametre
     if (pos < 0 || arraysize < 1 || insertsize < 1 || pos >= arraysize) {

wildcard.h

@@ -12,9 +12,38 @@
 #include "constante.h"
 
 /* --- Fonctions publiques ---*/
+/**
+ * Indique le nombre de fichiers correspond à la sequence dans le dossier de
+ * travail courrant
+ * @param const char* La sequence
+ * @return int Le nombre de fichiers correspondant (0 si aucun ou si le nom du
+ * fichier est identique à la sequence)
+ */
 int wildcard_result(const char*);
+
+/**
+ * Recupere les fichiers correspondant à une sequence
+ * @param const char* La sequence
+ * @param int La taille du tableau (parametre suivant)
+ * @param char** Tableau qui accueillera le resultat
+ * @return int Le nombre d'élement mis dans le tableau (ne depasse jamais la
+ * capacité indiqué en paramètre)
+ */
 int wildcard(const char*, int, char**);
-char** insert_array(int pos, char** array, int arraysize, char** insert, int insertsize, int*);
+
+/**
+ * Insert un tableau à la place d'une valeur d'un autre tableau
+ * Tous les tableau passé en pramètre sont vidés et supprimés (ils doivent donc
+ * être alloué dynamiquement, de même pour leurs valeurs)
+ * @param int La position à remplacer dans le 1er tableau
+ * @param char** La tableau à dont un élément est à remplacer
+ * @param int La taille du tableau
+ * @param char** Le tableau à insérer dans l'autre tableau
+ * @param int La taille du tableau à inserer
+ * @param int* Variable récupérant la nouvelle taille du tableau (peut etre NULL)
+ * @return char** Le nouveau tableau
+ */
+char** insert_array(int, char**, int, char**, int, int*);
 
 #endif /* WILDCARD_H */