From b30a56110745a87761f0fcbabf6d1cbc33bee635 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20LAVERGNE?= <remi.lavergne@etu.uca.fr>
Date: Thu, 9 Nov 2023 17:25:27 +0100
Subject: [PATCH] Modification du main et ajout de la documentation

---
 src/main.c | 52 +++++++++++++++++++++++++++-------------------------
 src/main.h |  2 +-
 2 files changed, 28 insertions(+), 26 deletions(-)

diff --git a/src/main.c b/src/main.c
index 7837853..a94bbc0 100644
--- a/src/main.c
+++ b/src/main.c
@@ -1,21 +1,26 @@
+/**
+ * @file main.c
+ * @brief Fonctions principales du programme
+ * 
+ * Contient les fonctions principales du programme, notamment le menu principal.
+ * La fonction main() se trouve dans ce fichier et est executée au lancement.
+ * La fonction global() est la fonction principale du programme.
+*/
 #include "main.h"
 
+/**
+ * @brief Affichage du menu principal
+ * @return Choix de l'utilisateur
+*/
 int displayMenu(void)
 {
-    /*
-    Choix de l'action à réaliser
-
-    +return: choix de l'action
-
-    +var choice: choix de l'action
-    */
     int choice;
     
     printf("\nTapez sur Entrée pour continuer...");
     //TODO Clear le buffer pour éviter les problèmes
     if (getchar() == '\n') // getchar() pour récupérer le caractère entré par l'utilisateur
     {
-        printf("\e[1;1H\e[2J"); // Clear le terminal
+        system("clear"); // Clear le terminal
     }
 
     printf("\n=================================\n");
@@ -27,30 +32,23 @@ int displayMenu(void)
     printf("4. \u274C Quitter\n");
     printf("9. \u26A0 Débug\n");
     printf("=================================\n");
+    printf("\u00A9 2023 - Pascal Inc.\n\n");
     printf("Votre choix : ");
     scanf("%d%*c", &choice);
 
-    printf("\e[1;1H\e[2J");
+    system("clear");
 
     return choice;
 }
 
+/**
+ * @brief Fonction globale du programme
+ * Crée les variables et les tableaux nécessaires au programme,
+ * charge les données depuis les fichiers, affiche le menu principal
+ * et appelle les fonctions nécessaires en fonction du choix de l'utilisateur.
+*/
 void global(void)
 {
-    /*
-    Fonction global: Exécute les autres fonctions selon les choix de l'utilisateur
-
-    +var tLogArticle: taille logique des tableaux contenant les données des articles
-    +var tLogClient:  taille logique des tableaux contenant les données des clients
-    +var choice:      choix de l'action à réaliser
-    +var reference:   tableau des références des articles
-    +var clientID:    tableau des identifiants des clients
-    +var suspended:   tableau de l'état du compte des clients
-    +var weight:      tableau du poids des articles
-    +var volume:      tableau du volume des articles
-    +var unitPrice:   tableau du prix unitaire des actions
-    +var cagnotte:    tableau des cagnottes des clients
-    */
     // Déclaration des variables
     int tLogArticle, tLogClient, choice, status, currentUser;
     int reference[tmaxArticles], clientID[tmaxClients], clientPassword[tmaxClients], suspended[tmaxClients], isAdmin[tmaxClients];
@@ -60,9 +58,9 @@ void global(void)
     // Affichage du menu
     choice = displayMenu();
 
-    while (choice != 4)
+    while(choice != 4)
     {
-        switch (choice)
+        switch(choice)
         {
             case 1:
                 status = login(clientID, clientPassword, isAdmin, tLogClient);
@@ -114,6 +112,10 @@ void global(void)
     }
 }
 
+/**
+ * @brief Fonction principale du programme
+ * @return 0 si tout s'est bien passé et que le programme s'est terminé correctement
+*/
 int main(void)
 {
     global();
diff --git a/src/main.h b/src/main.h
index 7195831..ff64698 100644
--- a/src/main.h
+++ b/src/main.h
@@ -32,7 +32,7 @@ void decalageADroite(int tab[], int index, int tlog);
 void decalageAGauche(int tab[], int index, int tlog);
 
 //! GESTION CLIENTS
-int inputClient(int clientID[], float cagnotte[], int suspended[], int isAdmin[], int *tlog);
+int inputClient(int id, int passwd, int index, int clientID[], int clientPassword[], float cagnotte[], int suspended[], int isAdmin[], int *tlog);
 void modifyClient(int clientID[], float cagnotte[], int suspended[], int isAdmin[], int tlog);
 void deleteClient(int clientID[], float cagnotte[], int suspended[], int isAdmin[], int *tlog);