Modification de la documentation

master
Kyllian CHABANON 2 years ago
parent 7d6f9c270c
commit a7d12c486f

@ -1,19 +1,21 @@
/**
* \file Affichage.c
* \brief Fichier qui contient toutes les fonctions d'affichage
* \author
* \brief Fichier contenant toutes les fonctions d'affichage
* \author Antoine Perederii - Ayour Malki
*/
#include "Fonctions.h"
/**
* \brief Affiche les informations d'un adhérent
* \author
* \author Antoine Perederii - Ayour Malki
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param nbElem taille logique des tableaux
*
* Affiche le numéro de carte, l'âge, le nombre de points restants et l'état de la carte d'un adhérent.
*/
void Affichage1Adherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int nbElem)
{
@ -35,12 +37,14 @@ void Affichage1Adherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCar
/**
* \brief Affiche les informations de tous les adhérents
* \author
* \author Antoine Perederii - Ayour Malki
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param nbElem taille logique des tableaux
*
* Affiche le numéro de carte, l'âge, le nombre de points restants et l'état de la carte de l'adhérent recherché.
*/
void AffichageTousAdherents(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int nbElem)
{
@ -54,7 +58,7 @@ void AffichageTousAdherents(int tNoCarte[], int tAge[], int tPointsCarte[], int
/**
* \brief Affiche le nombre d'entrées de chaque jour
* \author
* \author Antoine Perederii
* \param tNbActivitesJour tableau contenant le nombre d'activités de chaque jour
* \param tDate tableau contenant les dates
* \param nbElem taille logique des tableaux
@ -71,7 +75,7 @@ void AffichageNbEntreesTousJour(int tNbActivitesJour[], int tDate[], int nbElem)
/**
* \brief Affiche le nombre d'entrées total
* \author
* \author Ayour Malki
* \param tNbActivitesJour tableau contenant le nombre d'activités de chaque jour
* \param nbElem taille logique du tableau
*/
@ -87,7 +91,7 @@ void AffichageNbEntreesTotal(int tNbActivitesJour[], int nbElem)
/**
* \brief Affiche le nombre d'adhérents
* \author
* \author Ayour Malki
* \param nbElem taille logique des tableaux
*/
void AffichageNbAdherents(int nbElem)

@ -1,14 +1,14 @@
/**
* \file GestionAdherents.c
* \brief Fichier qui contient les fonctions de gestion des adhérents
* \author
* \brief Fichier contenant les fonctions de gestion des adhérents
* \author Antoine Perederii - Ayour Malki
*/
#include "Fonctions.h"
/**
* \brief Recherche un adhérent pour la fonction AjoutAdherent
* \author
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param nbElem taille logique du tableau
* \param noCarte numéro de la carte à rechercher
@ -28,11 +28,11 @@ int RechercheAjoutAdherent(int tNoCarte[], int nbElem, int noCarte)
/**
* \brief Affiche les informations d'un adhérent
* \author
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param tMax taille physique des tableaux
* \param nbElem taille logique des tableaux
* \return la nouvelle taille logique des tableaux
@ -68,11 +68,13 @@ int AjoutAdherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActi
}
/**
* \brief Permet de modifier l'âge d'un adhérent
* \author
* \brief Modifie l'âge d'un adhérent
* \author Kyllian Chabanon
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param nbElem taille logique des tableaux
*
* Permet de modifier l'âge de l'adhérent recherché.
*/
void ModificationAge(int tNoCarte[], int tAge[], int nbElem)
{
@ -95,12 +97,12 @@ void ModificationAge(int tNoCarte[], int tAge[], int nbElem)
}
/**
* \brief Permet de supprimer un adhérent
* \author
* \brief Supprime un adhérent
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param nbElem taille logique des tableaux
* \return la nouvelle taille logique des tableaux
*/
@ -132,10 +134,14 @@ int SupprimerAdherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarte
/**
* \brief Modifie l'état de la carte
* \author
* \author Kyllian Chabanon
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param nbElem taille logique des tableaux
*
* Permet de modifier l'état de la carte de l'adhérent recherché.
* L'état peut être 0 si la carte est activée et 1 si elle est désactivée.
* Il est possible de choisir la raison de l'activation et de la désactivation de la carte.
*/
void ModificationActivationCarte(int tNoCarte[], int tCarteActive[], int nbElem)
{

@ -1,18 +1,18 @@
/**
* \file GestionPoints.c
* \brief Contient les fonctions pour la gestion des points des adhérents
* \author
* \brief Fichier contenant les fonctions pour la gestion des points des adhérents
* \author Antoine Perederii - Kyllian Chabanon
*/
#include "Fonctions.h"
/**
* \brief Permet de rechercher un adhérent
* \author
* \brief Recherche un adhérent
* \author Kyllian Chabanon
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param nbElem taille logique des tableaux
* \param noCarte numéro de la carte à rechercher
* \param trouve pointeur qui prend comme valeur 1 si le numéro a été trouvé et 0 sinon
* \param trouve pointeur prenant comme valeur 1 si le numéro a été trouvé et 0 sinon
* \return l'index où se trouve le numéro de la carte recherché, s'il n'y est pas, retourne l'endroit où il doit être inséré
*/
int RechercheAdherent(int tNoCarte[], int nbElem, int noCarte, int *trouve)
@ -35,12 +35,19 @@ int RechercheAdherent(int tNoCarte[], int nbElem, int noCarte, int *trouve)
/**
* \brief Ajoute des points sur une carte
* \author
* \author Kyllian Chabanon
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param nbElem taille logique des tableaux
* \param noCarte numéro de la carte à créditer
*
* Perlet d'ajouter des points à la carte correspondant au numéro de carte donné en paramètre.
* Il y a des bonus donnés selon le nombre de points ajoutés :
* - En dessous de 20 : aucun bonus
* - Entre 21 et 50 : 5%
* - Entre 51 et 100 : 10%
* - Au dessus de 101 : 15%
*/
void AjoutPoints(int tNoCarte[], int tPointsCarte[], int tCarteActive[], int nbElem, int noCarte)
{
@ -90,9 +97,9 @@ void AjoutPoints(int tNoCarte[], int tPointsCarte[], int tCarteActive[], int nbE
/**
* \brief Débite une carte lorsqu'un adhérent pratique une activité
* \author
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param tNbActivitesJour tableau contenant le nombre d'activité qui a été faite dans la journée
* \param nbElem taille logique des tableaux
*/

@ -1,7 +1,7 @@
/**
* \file Global.c
* \brief Fichier qui contient la fonction de gestion des menus
* \author
* \brief Fichier contenant la fonction de gestion des menus
* \author Antoine Perederii
*/
#include "Fonctions.h"
@ -23,8 +23,8 @@ Votre application doit pouvoir interdire à un adhérent de fréquenter le centr
*/
/**
* \brief Permet de gérer les menus en appelant une fonction pour chaque choix fait par l'utilisateur
* \author
* \brief Gère les menus en appelant une fonction pour chaque choix fait par l'utilisateur
* \author Antoine Perederii - Ayour Malki
*/
void GestionMenus(void)
{

@ -1,14 +1,14 @@
/**
* \file Menus.c
* \brief Fichier qui contient les fonctions du menu
* \author
* \author Antoine Perederii - Ayour Malki - Kyllian Chabanon
*/
#include "Fonctions.h"
/**
* \brief Affiche le menu principal et permet de choisir une option
* \author
* \author Antoine Perederii - Ayour Malki
* \return le choix entré par l'utilisateur
*/
int ChoixMenu(void)
@ -30,7 +30,7 @@ int ChoixMenu(void)
/**
* \brief Affiche le menu d'affichage et permet de choisir une option
* \author
* \author Ayour Malki - Antoine Perederii
* \return le choix entré par l'utilisateur
*/
int ChoixMenuAffichage(void)

@ -1,19 +1,19 @@
/**
* \file Ouverture.c
* \brief Contient les fonctions d'ouverture des fichiers
* \author
* \brief Fichier contenant les fonctions d'ouverture des fichiers de données
* \author Antoine Perederii
*/
#include "Fonctions.h"
/**
* \brief Appelle les fonctions d'ouverture
* \author
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tNbActivitesJour tableau qui contient le nombre d'activité par jour
* \param tDate tableau qui contient les dates
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param tNbActivitesJour tableau contenant le nombre d'activité par jour
* \param tDate tableau contenant les dates
* \param tMax taille physique des tableaux
* \param pasAct pointeur contenant la taille logique des tableaux des activités
* \return la taille logique des tableaux des membres
@ -28,13 +28,16 @@ int Ouverture(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[]
/**
* \brief Charge les données du fichier membres.don dans des tableaux
* \author
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param tMax taille physique des tableaux
* \return la taille logique des tableaux
*
* Parcourt chaque champ dans le fichier membres.don et insère dans le tableau correspondant sa valeur.
* Renvoie un message d'erreur si le fichier n'existe pas.
*/
int OuvertureMembres(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int tMax)
{
@ -69,11 +72,14 @@ int OuvertureMembres(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteA
/**
* \brief Charge les données du fichier ActivitesJour.don dans des tableaux
* \author
* \param tNbActivitesJour tableau qui contient le nombre d'activité par jour
* \param tDate tableau qui contient les dates
* \author Antoine Perederii
* \param tNbActivitesJour tableau contenant le nombre d'activité par jour
* \param tDate tableau contenant les dates
* \param tMax taille physique des tableaux
* \return la taille logique des tableaux
*
* Parcourt chaque champ dans le fichier ActivitesJour.don et insère dans le tableau correspondant sa valeur.
* Renvoie un message d'erreur si le fichier n'existe pas.
*/
int OuvertureActivitesJour(int tNbActivitesJour[], int tDate[], int tMax)
{

@ -21,9 +21,9 @@ Il existe plusieurs activités :
Lorsqu'un client décide de faire une activité, il est discrédité du nombre de points correspondants.
A chaque entrée, le client peut choisir plusieurs activités. Sa carte se fait alors débiter de la somme des points des différentes activités choisies.
**Antoine** : Ouverture.c, Sauvegarde.c, Menu.c, main.c, Global.c, GestionAdherents.c, Fonctions.h, Affichage.c
**Ayour** : Affichage.c, Menu.c, Fonctions.h, Global.c, main.c, GestionAdherents.c
**Kyllian** : Fonctions.h, GestionPoints.c, Global.c, main.c, Menu.c, GestionAdherents.c
**Antoine** : Ouverture.c, Sauvegarde.c, Menus.c, Global.c, GestionAdherents.c, Affichage.c
**Ayour** : Affichage.c, Menus.c, Global.c, GestionAdherents.c
**Kyllian** : GestionPoints.c, Global.c, Menu.c, GestionAdherents.c
### Fonctionnalités

@ -1,20 +1,20 @@
/**
* \file Sauvegarde.c
* \brief Contient la fonction de sauvegarde
* \author
* \brief Fichier contenant la fonction de sauvegarde
* \author Antoine Perederii
*/
#include "Fonctions.h"
/**
* \brief Sauvegarde les nouvelles données dans les fichiers
* \author
* \author Antoine Perederii
* \param tNoCarte tableau contenant les numéros de toutes les cartes
* \param tAge tableau contenant les âges des membres
* \param tPointsCarte tableau qui contient le nombre de points restants sur chaque carte
* \param tCarteActive tableau qui contient l'état de chaque carte
* \param tNbActivitesJour tableau qui contient le nombre d'activité par jour
* \param tDate tableau qui contient les dates
* \param tPointsCarte tableau contenant le nombre de points restants sur chaque carte
* \param tCarteActive tableau contenant l'état de chaque carte
* \param tNbActivitesJour tableau contenant le nombre d'activité par jour
* \param tDate tableau contenant les dates
* \param nbElem taille logique des tableaux tNoCarte, tAge, tPointsCarte et tCarteActive
* \param pasAct taille logique des tableaux tNbActivitesJour et tDate
* \return le code d'erreur : -1 en cas d'erreur et 0 sinon
@ -22,10 +22,10 @@
int Sauvegarde(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int tNbActivitesJour[], int tDate[], int nbElem, int pasAct)
{
int i, j;
FILE *flot, *jour;
flot = fopen("membres.don", "w");
FILE *membres, *jour;
membres = fopen("membres.don", "w");
jour = fopen("ActivitesJour.don", "w");
if (flot == NULL)
if (membres == NULL)
{
printf("Problème d'ouverture du fichier membres.don en écriture.\n");
return -1;
@ -37,13 +37,13 @@ int Sauvegarde(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[
}
for (i = 0; i < (nbElem - 1); i++)
{
fprintf(flot, "\t%d\t%d\t\t%d\t\t%d\n", tNoCarte[i], tAge[i], tPointsCarte[i], tCarteActive[i]);
fprintf(membres, "%d\t%d\t\t%d\t\t%d\n", tNoCarte[i], tAge[i], tPointsCarte[i], tCarteActive[i]);
}
for (j = 0; j < (nbElem - 1); j++)
{
fprintf(jour, "%d\t\t%d\n", tDate[j], tNbActivitesJour[j]);
}
fclose(jour);
fclose(flot);
fclose(membres);
return 0;
}
Loading…
Cancel
Save