From 2580e0e25fd6628ab6348a86541ea1f0fc99396b Mon Sep 17 00:00:00 2001
From: "louis.germain" <logermain@iutclinfa1912l.iut.local>
Date: Fri, 20 Oct 2023 14:02:29 +0200
Subject: [PATCH] Ajout des commentaires pour les fonctions dans modif et
 traitement

---
 src/modif.c      | 39 ++++++++++++++++++--
 src/traitement.c | 92 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 129 insertions(+), 2 deletions(-)

diff --git a/src/modif.c b/src/modif.c
index 536a7c0..6bac13c 100644
--- a/src/modif.c
+++ b/src/modif.c
@@ -2,7 +2,16 @@
 
 void inputClient(int clientID[], float cagnotte[], int suspended[], int *tlog)
 {
-    //A modif pour passer dans les tableaux mais pas les fichiers
+    /*
+    Ajout d'un ou plusieurs clients dans les tableaux
+
+    +param clientID:  tableau des identifiants des clients
+    +param cagnotte:  tableau des cagnottes des clients
+    +param suspended: tableau de l'état du compte des clients
+    +param tlog:      taille logique des tableaux des clients
+
+    +var numClient: identifiant du cliet à ajouter
+    */
     int numClient = -1;
 
     while (numClient != 0)
@@ -23,6 +32,19 @@ void inputClient(int clientID[], float cagnotte[], int suspended[], int *tlog)
 
 void modifyClient(int clientID[], float cagnotte[], int suspended[], int tlog)
 {
+    /*
+    Modification des données d'un client dans les tableaux
+
+    +param clientID:  tableau des identifiants des clients
+    +param cagnotte:  tableau des cagnottes des clients
+    +param suspended: tableau de l'état du compte des clients
+    +param tlog:      taille logique des tableaux des clients
+
+    +var numClient: identifiant du client à modifier
+    +var index:     index de l'article recherché dans le tableau pour le modifier
+    +var montant:   montant à ajouter à la cagnotte
+    +var modif:     modification à exécuter sur le client
+    */
     int index, numClient, montant;
     char modif;
     printf("Entrez le numéro du client dont vous voulez modifier les données: ");
@@ -55,7 +77,20 @@ void modifyClient(int clientID[], float cagnotte[], int suspended[], int tlog)
 
 void inputItem(int tabReference[], float tabWeight[], float tabVolume[], float unitPrice[], int *tlog)
 {
-    //A modif pour passer dans les tableaux mais pas les fichiers
+    /*
+    Ajout d'un ou plusieurs articles dans les tableaux d'articles (reference, poids, volume et prix)
+
+    +param tabReference: tableau des références des articles
+    +param weight:       tableau des poids des articles
+    +param volume:       tableau des volumes des articles
+    +param unitPrice:    tableau des prix à l'unité des articles
+    +param tlog:         taille logique des tableaux des articles
+
+    +var reference: reference de l'article à ajouter
+    +var weight:    poids de l'article à ajouter
+    +var volume:    volume de l'article à ajoueter
+    +var price:     prix de l'article à ajouter
+    */
     int reference = -1;
     float weight, volume, price;
     while (reference != 0)
diff --git a/src/traitement.c b/src/traitement.c
index 1b342bd..69eb8b7 100644
--- a/src/traitement.c
+++ b/src/traitement.c
@@ -8,6 +8,17 @@
 
 int recherche(int val, int tab[], int tlog) // Recherche de l'index d'un id (de client ou d'article)
 {
+    /*
+    Recherche d'une valeur dans un tableau
+
+    +param val:  valeur à rechercher dans le tableau
+    +param tab:  tableau dans lequel rechercher
+    +param tlog: taille logique du tableau tab
+
+    +return: index de la valeur dans le tableau
+
+    +var i: compteur pour trouver l'index de la valeur
+    */
     int i;
     for (i=0; i<tlog; i++)
     {
@@ -19,12 +30,42 @@ int recherche(int val, int tab[], int tlog) // Recherche de l'index d'un id (de
 
 void chargeDonnees(int *tLogArticle, int *tLogClient,int reference[], float weight[], float volume[], float unitPrice[], int clientID[], float cagnotte[], int suspended[])
 {
+    /*
+    Chargement des données des articles et clients de fichiers vers des tableaux
+
+    +param tLogArticle: taille logique des tableaux des articles
+    +param tLogClient:  taille logique des tableaux des clients
+    +param reference:   tableau des références des articles
+    +param weight:      tableau des poids des articles
+    +param volume:      tableau des volumes des articles
+    +param unitPrice:   tableau des prix à l'unité des articles
+    +param clientID:    tableau des identifiants des clients
+    +param cagnotte:    tableau des cagnottes des clients
+    +param suspended:   tableau de l'état du compte des clients
+    */
     *tLogArticle = chargeArticles(reference, weight, volume, unitPrice);
     *tLogClient = chargeClients(clientID, cagnotte, suspended);
 }
 
 int chargeArticles(int reference[], float weight[], float volume[], float unitPrice[])
 {
+    /*
+    Chargement des données des articles d'un fichier vers des tableaux
+    
+    +param reference:   tableau des références des articles
+    +param weight:      tableau des poids des articles
+    +param volume:      tableau des volumes des articles
+    +param unitPrice:   tableau des prix à l'unité des articles
+
+    +return: taille logique des tableaux
+
+    +var article: fichier 'articles.txt' ouvert en lecture
+    +var ref:     reference de l'article
+    +var tL:      taille logique des tableaux
+    +var w:       poids de l'article
+    +var v:       volume de l'article
+    +var up:      prix de l'article à l'unité
+    */
     FILE *article;
     article = fopen("articles.txt","r");
     if(article==NULL)
@@ -61,6 +102,21 @@ int chargeArticles(int reference[], float weight[], float volume[], float unitPr
 
 int chargeClients(int clientID[], float cagnotte[], int suspended[])
 {
+    /*
+    Chargement des données des clients d'un fichier vers des tableaux
+    
+    +param clientID:    tableau des identifiants des clients
+    +param cagnotte:    tableau des cagnottes des clients
+    +param suspended:   tableau de l'état du compte des clients
+
+    +return: taille logique des tableaux
+
+    +var client: fichier 'clients.txt' ouvert en lecture
+    +var id:     identifiant du client
+    +var sus:    état du compte du client
+    +var tL:     taille logique des tableaux
+    +var cag:    montant de la cagnotte du client
+    */
     FILE *client;
     client = fopen("clients.txt","r");
     if(client==NULL)
@@ -96,12 +152,37 @@ int chargeClients(int clientID[], float cagnotte[], int suspended[])
 
 void sauvegardeDonnees(int tLogArticle, int tLogClient, int reference[], float weight[], float volume[], float unitPrice[], int clientID[], float cagnotte[], int suspended[])
 {
+    /*
+    Sauvegarde des données des articles et clients de tableaux vers des fichiers
+
+    +param tLogArticle: taille logique des tableaux des articles
+    +param tLogClient:  taille logique des tableaux des clients
+    +param reference:   tableau des références des articles
+    +param weight:      tableau des poids des articles
+    +param volume:      tableau des volumes des articles
+    +param unitPrice:   tableau des prix à l'unité des articles
+    +param clientID:    tableau des identifiants des clients
+    +param cagnotte:    tableau des cagnottes des clients
+    +param suspended:   tableau de l'état du compte des clients
+    */
     sauvegardeArticles(reference, weight, volume, unitPrice, tLogArticle);
     sauvegardeClients(clientID, cagnotte, suspended, tLogClient);
 }
 
 void sauvegardeArticles(int reference[], float weight[], float volume[], float unitPrice[], int tLogArticle)
 {
+    /*
+    Sauvegarde des données des articles de tableaux vers le fichier des articles
+    
+    +param reference:   tableau des références des articles
+    +param weight:      tableau des poids des articles
+    +param volume:      tableau des volumes des articles
+    +param unitPrice:   tableau des prix à l'unité des articles
+    +param tLogArticle: taille logique des tableaux des articles
+
+    +var article: fichier 'articles.txt' ouvert en écriture
+    +var i:       compteur permettant de parcourir les tableaux
+    */
     FILE *article;
     article = fopen("articles.txt","w");
     if(article==NULL)
@@ -121,6 +202,17 @@ void sauvegardeArticles(int reference[], float weight[], float volume[], float u
 
 void sauvegardeClients(int clientID[], float cagnotte[], int suspended[], int tLogClient)
 {
+    /*
+    Sauvegarde des données des articles de tableaux vers le fichier des articles
+
+    +param clientID:    tableau des identifiants des clients
+    +param cagnotte:    tableau des cagnottes des clients
+    +param suspended:   tableau de l'état du compte des clients
+    +param tLogClient:  taille logique des tableaux des clients
+    
+    +var client: fichier 'clients.txt' ouvert en lecture
+    +var i:      compteur permettant de parcourir les tableaux
+    */
     FILE *client;
     client = fopen("clients.txt","w");
     if(client==NULL)