MODIFY doxygen

pull/13/head
yannis.doumir_fernandes 1 year ago
parent 6d114d9137
commit 0af48df2c6

@ -7,6 +7,7 @@
/** /**
* @brief Charge les informations des articles à partir d'un fichier dans des tableaux. * @brief Charge les informations des articles à partir d'un fichier dans des tableaux.
* @author Yannis Doumir Fernandes
* *
* Cette fonction lit les informations des articles à partir du fichier "donnee/articles.txt" et les stocke * Cette fonction lit les informations des articles à partir du fichier "donnee/articles.txt" et les stocke
* dans les tableaux tRef, tPoids, tVol, et tPrix. * dans les tableaux tRef, tPoids, tVol, et tPrix.
@ -22,6 +23,7 @@ int chargementArticles(int tRef[], float tPoids[], float tVol[], float tPrix[],
/** /**
* @brief Sauvegarde les informations des articles dans un fichier. * @brief Sauvegarde les informations des articles dans un fichier.
* @author Yannis Doumir Fernandes
* *
* Cette fonction sauvegarde les informations des articles depuis les tableaux tRef, tPoids, tVol et tPrix * Cette fonction sauvegarde les informations des articles depuis les tableaux tRef, tPoids, tVol et tPrix
* dans le fichier "donnee/articles.txt". * dans le fichier "donnee/articles.txt".
@ -36,6 +38,7 @@ void sauvegardArticles(int tRef[], float tPoids[], float tVol[], float tPrix[],
/** /**
* @brief Ajoute un nouvel article aux tableaux d'articles. * @brief Ajoute un nouvel article aux tableaux d'articles.
* @author Yannis Doumir Fernandes
* *
* Cette fonction ajoute un nouvel article aux tableaux tRef, tPoids, tVol, et tPrix et incrémente la taille logique. * Cette fonction ajoute un nouvel article aux tableaux tRef, tPoids, tVol, et tPrix et incrémente la taille logique.
* *
@ -55,6 +58,7 @@ int ajouterArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], int
/** /**
* @brief Recherche une référence d'article dans le tableau tRef. * @brief Recherche une référence d'article dans le tableau tRef.
* @author Yannis Doumir Fernandes
* *
* Cette fonction recherche une référence d'article dans le tableau tRef et renvoie l'index si l'article est trouvé. * Cette fonction recherche une référence d'article dans le tableau tRef et renvoie l'index si l'article est trouvé.
* *
@ -67,6 +71,7 @@ void rechercheRefArticle(int tRef[], int ref, int *index, int tLogique);
/** /**
* @brief Supprime un article des tableaux d'articles. * @brief Supprime un article des tableaux d'articles.
* @author Yannis Doumir Fernandes
* *
* Cette fonction supprime un article des tableaux tRef, tPoids, tVol, et tPrix et met à jour la taille logique. * Cette fonction supprime un article des tableaux tRef, tPoids, tVol, et tPrix et met à jour la taille logique.
* *
@ -80,6 +85,7 @@ void supprimerArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], i
/** /**
* @brief Modifie les informations d'un article existant. * @brief Modifie les informations d'un article existant.
* @author Yannis Doumir Fernandes
* *
* Cette fonction permet de modifier les informations (poids, volume, prix) d'un article existant. * Cette fonction permet de modifier les informations (poids, volume, prix) d'un article existant.
* *
@ -93,6 +99,7 @@ void modifierArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], in
/** /**
* @brief Ajoute un nouveau client aux tableaux de clients. * @brief Ajoute un nouveau client aux tableaux de clients.
* @author Yannis Doumir Fernandes
* *
* Cette fonction ajoute un nouveau client aux tableaux tNumClient, tCagnotte et tSus et incrémente la taille logique. * Cette fonction ajoute un nouveau client aux tableaux tNumClient, tCagnotte et tSus et incrémente la taille logique.
* *
@ -106,6 +113,7 @@ void ajouterClient(int tNumClient[], float tCagnotte[], int tSus[], int *tLogiqu
/** /**
* @brief Décode le mot de passe du fichier mdp.txt pour le comparer avec le mdp entré. * @brief Décode le mot de passe du fichier mdp.txt pour le comparer avec le mdp entré.
* @author Yannis Doumir Fernandes
* *
* @param mdpEnter Mot de passe entrer par l'utilisateur. * @param mdpEnter Mot de passe entrer par l'utilisateur.
*/ */
@ -113,6 +121,7 @@ int decodageMDP(char *mdpEnter);
/** /**
* @brief Lis le mot de passe codé dans le fichier mdp.txt, le compare au mot de passe entré à laide de decodageMDP * @brief Lis le mot de passe codé dans le fichier mdp.txt, le compare au mot de passe entré à laide de decodageMDP
* @author Yannis Doumir Fernandes
* *
* @param texte chaine de caractère comparé avec le mot de passe du fichier. * @param texte chaine de caractère comparé avec le mot de passe du fichier.
* @param decalage entier qui sert de clé pour déchiffrer le mot de passe. * @param decalage entier qui sert de clé pour déchiffrer le mot de passe.

@ -1,7 +1,4 @@
/**
* @file interface_resp.c
* @brief Implémentation des fonctions liées à l'interface du responsable.
*/
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
@ -14,9 +11,7 @@
#define MAX_SIZE_MDP 20 #define MAX_SIZE_MDP 20
#define MENU_QUIT 12 #define MENU_QUIT 12
/**
* @brief Affiche le menu principal de l'interface du responsable.
*/
void affiche_resp(void) { void affiche_resp(void) {
printf("\n"); printf("\n");
printf("+-------------+\n"); printf("+-------------+\n");
@ -40,15 +35,6 @@ void affiche_resp(void) {
printf("+----------------------------------------------------------------+\n"); printf("+----------------------------------------------------------------+\n");
} }
/**
* @brief Affiche la liste des articles.
*
* @param tRef - Tableau des références d'articles.
* @param tPoids - Tableau des poids d'articles.
* @param tVol - Tableau des volumes d'articles.
* @param tPrix - Tableau des prix d'articles.
* @param tLogique - Taille logique des tableaux.
*/
void affichArticles(int tRef[], float tPoids[], float tVol[], float tPrix[], int tLogique) { void affichArticles(int tRef[], float tPoids[], float tVol[], float tPrix[], int tLogique) {
printf("\t Liste des articles\n\n"); printf("\t Liste des articles\n\n");
printf("\t Ref\t Poids\t Volume\t Prix\n"); printf("\t Ref\t Poids\t Volume\t Prix\n");
@ -57,15 +43,7 @@ void affichArticles(int tRef[], float tPoids[], float tVol[], float tPrix[], int
} }
} }
/**
* @brief Affiche un article spécifique.
*
* @param tRef - Tableau des références d'articles.
* @param tPoids - Tableau des poids d'articles.
* @param tVol - Tableau des volumes d'articles.
* @param tPrix - Tableau des prix d'articles.
* @param tLogique - Taille logique des tableaux.
*/
void affichUnArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], int tLogique) { void affichUnArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], int tLogique) {
int ref; int ref;
printf("\tQuelle est la référence de l'article à rechercher ?\n"); printf("\tQuelle est la référence de l'article à rechercher ?\n");
@ -83,14 +61,7 @@ void affichUnArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], in
printf("\t Article introuvable\n"); printf("\t Article introuvable\n");
} }
/**
* @brief Affiche un client spécifique.
*
* @param tNumClient - Tableau des numéros de client.
* @param tCagnotte - Tableau des cagnottes des clients.
* @param tSus - Tableau d'états des clients.
* @param tLogique - Taille logique des tableaux.
*/
void affichUnClient(int tNumClient[], float tCagnotte[], int tSus[], int tLogique) { void affichUnClient(int tNumClient[], float tCagnotte[], int tSus[], int tLogique) {
int numC; int numC;
printf("\tVeuillez entrer le numéro du client à rechercher\n"); printf("\tVeuillez entrer le numéro du client à rechercher\n");
@ -108,14 +79,6 @@ void affichUnClient(int tNumClient[], float tCagnotte[], int tSus[], int tLogiqu
printf("Client introuvable\n"); printf("Client introuvable\n");
} }
/**
* @brief Affiche la liste des clients.
*
* @param tNumClient - Tableau des numéros de client.
* @param tCagnotte - Tableau des cagnottes des clients.
* @param tSus - Tableau d'états des clients.
* @param tLogique - Taille logique des tableaux.
*/
void affichClients(int tNumClient[], float tCagnotte[], int tSus[], int tLogique) { void affichClients(int tNumClient[], float tCagnotte[], int tSus[], int tLogique) {
printf("\t Liste des clients\n"); printf("\t Liste des clients\n");
printf("\t NumClient\t Cagnotte\t Etat\n"); printf("\t NumClient\t Cagnotte\t Etat\n");
@ -125,14 +88,6 @@ void affichClients(int tNumClient[], float tCagnotte[], int tSus[], int tLogique
printf("\t Fin de la liste !\n"); printf("\t Fin de la liste !\n");
} }
/**
* @brief Affiche les informations pour ajouter un nouvel article.
*
* @param[in, out] ref - Référence du nouvel article.
* @param[in, out] poids - Poids du nouvel article.
* @param[in, out] volume - Volume du nouvel article.
* @param[in, out] prix - Prix du nouvel article.
*/
void affichAjoutArticle(int *ref, float *poids, float *volume, float *prix) { void affichAjoutArticle(int *ref, float *poids, float *volume, float *prix) {
printf("\t Entrez la ref du nouveau produit\n"); printf("\t Entrez la ref du nouveau produit\n");
while (scanf("%d", ref) != 1 || *ref <= 0) { while (scanf("%d", ref) != 1 || *ref <= 0) {
@ -160,11 +115,6 @@ void affichAjoutArticle(int *ref, float *poids, float *volume, float *prix) {
} }
} }
/**
* @brief Affiche les informations pour supprimer un article.
*
* @param[in, out] ref - Référence de l'article à supprimer.
*/
void affichSupprimerArticle(int *ref) { void affichSupprimerArticle(int *ref) {
printf("\t Quelle est la référence de l'article que vous voulez supprimer ?\n"); printf("\t Quelle est la référence de l'article que vous voulez supprimer ?\n");
while (scanf("%d", ref) != 1 || *ref <= 0) { while (scanf("%d", ref) != 1 || *ref <= 0) {
@ -173,14 +123,7 @@ void affichSupprimerArticle(int *ref) {
} }
} }
/**
* @brief Affiche les informations pour modifier un article.
*
* @param[in, out] ref - Référence de l'article à modifier.
* @param[in, out] poids - Nouveau poids de l'article.
* @param[in, out] volume - Nouveau volume de l'article.
* @param[in, out] prix - Nouveau prix de l'article.
*/
void affichModifierArticle(int *ref, float *poids, float *volume, float *prix) { void affichModifierArticle(int *ref, float *poids, float *volume, float *prix) {
printf("\t Quelle est la référence de l'article que vous voulez modifier ?\n"); printf("\t Quelle est la référence de l'article que vous voulez modifier ?\n");
while (scanf("%d", ref) != 1 || *ref <= 0) { while (scanf("%d", ref) != 1 || *ref <= 0) {
@ -207,13 +150,6 @@ void affichModifierArticle(int *ref, float *poids, float *volume, float *prix) {
} }
} }
/**
* @brief Affiche les informations pour ajouter un nouveau client.
*
* @param[in] tNumClient - Tableau des numéros de client.
* @param[in] tLogique - Taille logique des tableaux.
* @param[in, out] numC - Numéro du nouveau client.
*/
void affichAjoutClient(int tNumClient[], int tLogique, int *numC) { void affichAjoutClient(int tNumClient[], int tLogique, int *numC) {
printf("\t Veuillez entrer le numéro du nouveau client\n"); printf("\t Veuillez entrer le numéro du nouveau client\n");
while (scanf("%d", numC) != 1 || *numC <= 0) { while (scanf("%d", numC) != 1 || *numC <= 0) {
@ -228,12 +164,6 @@ void affichAjoutClient(int tNumClient[], int tLogique, int *numC) {
} }
} }
/**
* @brief Affiche les informations nécessaires pour entrer le mod de passe responsable.
*
* Cette fonction permet au responsable de confirmer son identité
*/
int affichageConnexion(void) int affichageConnexion(void)
{ {
char mdpEnter[20]; char mdpEnter[20];
@ -399,11 +329,6 @@ void affichModifMDP()
} }
} }
/**
* @brief Fonction de menu pour le responsable.
*
* @param[in, out] choix - L'option choisie par le responsable.
*/
void menu_resp(int *choix) { void menu_resp(int *choix) {
affiche_resp(); affiche_resp();
printf("Vous choisissez: "); printf("Vous choisissez: ");
@ -414,9 +339,6 @@ void menu_resp(int *choix) {
} }
} }
/**
* @brief Fonction principale de l'interface du responsable.
*/
void global_resp() { void global_resp() {
int choix, ref = 0; int choix, ref = 0;
float poids = 0, volume = 0, prix = 0; float poids = 0, volume = 0, prix = 0;

@ -5,7 +5,7 @@
/** /**
* @brief Affiche la liste des articles. * @brief Affiche la liste des articles.
* * @author Yannis Doumir Fernandes
* @param tRef - Tableau des références des articles. * @param tRef - Tableau des références des articles.
* @param tPoids - Tableau des poids des articles. * @param tPoids - Tableau des poids des articles.
* @param tVol - Tableau des volumes des articles. * @param tVol - Tableau des volumes des articles.
@ -16,6 +16,7 @@ void affichArticles(int tRef[], float tPoids[], float tVol[], float tPrix[], int
/** /**
* @brief Affiche les informations d'un article spécifique. * @brief Affiche les informations d'un article spécifique.
* @author Yannis Doumir Fernandes
* *
* @param tRef - Tableau des références des articles. * @param tRef - Tableau des références des articles.
* @param tPoids - Tableau des poids des articles. * @param tPoids - Tableau des poids des articles.
@ -27,6 +28,7 @@ void affichUnArticle(int tRef[], float tPoids[], float tVol[], float tPrix[], in
/** /**
* @brief Affiche les informations d'un client spécifique. * @brief Affiche les informations d'un client spécifique.
* @author Yannis Doumir Fernandes
* *
* @param tNumClient - Tableau des numéros de clients. * @param tNumClient - Tableau des numéros de clients.
* @param tCagnotte - Tableau des cagnottes des clients. * @param tCagnotte - Tableau des cagnottes des clients.
@ -37,6 +39,7 @@ void affichUnClient(int tNumClient[], float tCagnotte[], int tSus[], int tLogiqu
/** /**
* @brief Affiche la liste des clients. * @brief Affiche la liste des clients.
* @author Yannis Doumir Fernandes
* *
* @param tNumClient - Tableau des numéros de clients. * @param tNumClient - Tableau des numéros de clients.
* @param tCagnotte - Tableau des cagnottes des clients. * @param tCagnotte - Tableau des cagnottes des clients.
@ -47,6 +50,7 @@ void affichClients(int tNumClient[], float tCagnotte[], int tSus[], int tLogique
/** /**
* @brief Affiche les informations nécessaires pour ajouter un nouvel article. * @brief Affiche les informations nécessaires pour ajouter un nouvel article.
* @author Yannis Doumir Fernandes
* *
* @param ref - Référence du nouvel article. * @param ref - Référence du nouvel article.
* @param poids - Poids du nouvel article. * @param poids - Poids du nouvel article.
@ -57,6 +61,7 @@ void affichAjoutArticle(int *ref, float *poids, float *volume, float *prix);
/** /**
* @brief Affiche les informations nécessaires pour supprimer un article. * @brief Affiche les informations nécessaires pour supprimer un article.
* @author Yannis Doumir Fernandes
* *
* @param ref - Référence de l'article à supprimer. * @param ref - Référence de l'article à supprimer.
*/ */
@ -64,6 +69,7 @@ void affichSupprimerArticle(int *ref);
/** /**
* @brief Affiche les informations nécessaires pour modifier un article. * @brief Affiche les informations nécessaires pour modifier un article.
* @author Yannis Doumir Fernandes
* *
* @param ref - Référence de l'article à modifier. * @param ref - Référence de l'article à modifier.
* @param poids - Nouveau poids de l'article. * @param poids - Nouveau poids de l'article.
@ -74,11 +80,14 @@ void affichModifierArticle(int *ref, float *poids, float *volume, float *prix);
/** /**
* @brief Affiche un message en cas de problème lors de la recherche d'un article. * @brief Affiche un message en cas de problème lors de la recherche d'un article.
* @author Yannis Doumir Fernandes
*
*/ */
void problemRechercheArticle(); void problemRechercheArticle();
/** /**
* @brief Affiche les informations nécessaires pour ajouter un nouveau client. * @brief Affiche les informations nécessaires pour ajouter un nouveau client.
* @author Yannis Doumir Fernandes
* *
* @param tNumClient - Tableau des numéros de clients. * @param tNumClient - Tableau des numéros de clients.
* @param tLogique - Nombre de clients actuellement enregistrés. * @param tLogique - Nombre de clients actuellement enregistrés.
@ -88,6 +97,7 @@ void affichAjoutClient(int tNumClient[], int tLogique, int *numC);
/** /**
* @brief Laisse le responsable choisir une option du menu. * @brief Laisse le responsable choisir une option du menu.
* @author Yannis Doumir Fernandes
* *
* @param[in, out] choix - L'option choisie par le responsable. * @param[in, out] choix - L'option choisie par le responsable.
*/ */
@ -96,6 +106,7 @@ void menu_resp(int *choix);
/** /**
* @brief Affiche les informations nécessaires pour entrer le mod de passe responsable. * @brief Affiche les informations nécessaires pour entrer le mod de passe responsable.
* @author Yannis Doumir Fernandes
* *
* Cette fonction permet au responsable de confirmer son identité * Cette fonction permet au responsable de confirmer son identité
*/ */
@ -103,11 +114,14 @@ int affichageConnexion(void);
/** /**
* @brief Affiche le menu qui permet de modifier l'état de la cagnotte d'un client. * @brief Affiche le menu qui permet de modifier l'état de la cagnotte d'un client.
* @author Yannis Doumir Fernandes
*
*/ */
void affichModifClient(int tNumClient[], int tSus[], int tLogique); void affichModifClient(int tNumClient[], int tSus[], int tLogique);
/** /**
* @brief Fonction principale de l'interface du responsable. * @brief Fonction principale de l'interface du responsable.
* @author Yannis Doumir Fernandes
* *
* Cette fonction permet au responsable d'effectuer diverses actions telles que la gestion des articles et des clients. * Cette fonction permet au responsable d'effectuer diverses actions telles que la gestion des articles et des clients.
*/ */
@ -115,5 +129,6 @@ void global_resp();
/** /**
* @brief Affiche le menu principal de l'interface du responsable. * @brief Affiche le menu principal de l'interface du responsable.
* @author Yannis Doumir Fernandes
*/ */
void affiche_resp(); void affiche_resp();

Loading…
Cancel
Save