Ajout de la documentation

Affichage.c

@@ -1,5 +1,20 @@
+/**
+ * \file Affichage.c
+ * \brief Fichier qui contient toutes les fonctions d'affichage
+ * \author : 
+*/
+
 #include "Fonctions.h"
 
+/**
+ * \brief Affiche les informations d'un adhérent
+ * \author :
+ * \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 nbElem taille logique des tableaux
+*/
 void Affichage1Adherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int nbElem)
 {
     int pas, noCarte, CarteActive, trouve;
@@ -18,6 +33,15 @@ void Affichage1Adherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCar
     }
 }
 
+/**
+ * \brief Affiche les informations de tous les adhérents
+ * \author :
+ * \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 nbElem taille logique des tableaux
+*/
 void AffichageTousAdherents(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int nbElem)
 {
     int i;
@@ -28,6 +52,13 @@ void AffichageTousAdherents(int tNoCarte[], int tAge[], int tPointsCarte[], int
     }
 }
 
+/**
+ * \brief Affiche le nombre d'entrées de chaque jour
+ * \author :
+ * \param tNbActivitesJour tableau contenant le nombre d'activités de chaque jour
+ * \param tDate tableau contenant les dates
+ * \param nbElem taille logique des tableaux
+*/
 void AffichageNbEntreesTousJour(int tNbActivitesJour[], int tDate[], int nbElem)
 {
     int i;
@@ -38,6 +69,12 @@ void AffichageNbEntreesTousJour(int tNbActivitesJour[], int tDate[], int nbElem)
     }
 }
 
+/**
+ * \brief Affiche le nombre d'entrées total
+ * \author :
+ * \param tNbActivitesJour tableau contenant le nombre d'activités de chaque jour
+ * \param nbElem taille logique du tableau
+*/
 void AffichageNbEntreesTotal(int tNbActivitesJour[], int nbElem)
 {
     int i, somme = 0;
@@ -48,6 +85,11 @@ void AffichageNbEntreesTotal(int tNbActivitesJour[], int nbElem)
     printf("Le nombre total d'entrées est de %d depuis le début.\n", somme);
 }
 
+/**
+ * \brief Affiche le nombre d'adhérents
+ * \author :
+ * \param nbElem taille logique des tableaux
+*/
 void AffichageNbAdherents(int nbElem)
 {
     int i, somme = 0;

GestionAdherents.c

@@ -1,5 +1,18 @@
+/**
+ * \file GestionAdherents.c
+ * \brief Fichier qui contient les fonctions de gestion des adhérents
+ * \author : 
+*/
+
 #include "Fonctions.h"
 
+/**
+ * \brief Permet de rechercher un adhérent pour la fonction AjoutAdherent
+ * \author :
+ * \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
+*/
 int RechercheAjoutAdherent(int tNoCarte[], int nbElem, int noCarte)
 {
     int i;
@@ -13,6 +26,17 @@ int RechercheAjoutAdherent(int tNoCarte[], int nbElem, int noCarte)
     }
 }
 
+/**
+ * \brief Affiche les informations d'un adhérent
+ * \author :
+ * \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 tMax taille physique des tableaux
+ * \param nbElem taille logique des tableaux
+ * \return la nouvelle taille logique des tableaux
+*/
 int AjoutAdherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int tMax, int nbElem)
 {
     int noCarte, age, pointsCarte, pas, trouve, j;
@@ -43,6 +67,13 @@ int AjoutAdherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActi
     return nbElem;
 }
 
+/**
+ * \brief Permet de modifier l'âge d'un adhérent
+ * \author :
+ * \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
+*/
 void ModificationAge(int tNoCarte[], int tAge[], int nbElem)
 {
     int pas, noCarte, age, trouve;
@@ -63,6 +94,16 @@ void ModificationAge(int tNoCarte[], int tAge[], int nbElem)
     }
 }
 
+/**
+ * \brief Permet de supprimer un adhérent
+ * \author :
+ * \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 nbElem taille logique des tableaux
+ * \return la nouvelle taille logique des tableaux
+*/
 int SupprimerAdherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarteActive[], int nbElem)
 {
     int pas, i, noCarte, trouve;
@@ -89,6 +130,13 @@ int SupprimerAdherent(int tNoCarte[], int tAge[], int tPointsCarte[], int tCarte
     }
 }
 
+/**
+ * \brief Modifie l'état de la carte
+ * \author :
+ * \param tNoCarte tableau contenant les numéros de toutes les cartes
+ * \param tCarteActive tableau qui contient l'état de chaque carte
+ * \param nbElem taille logique des tableaux
+*/
 void ModificationActivationCarte(int tNoCarte[], int tCarteActive[], int nbElem)
 {
     int noCarte, trouve, pas, choix, choixRaison;

GestionPoints.c

@@ -1,5 +1,20 @@
+/**
+ * \file GestionPoints.c
+ * \brief Contient les fonctions pour la gestion des points des adhérents
+ * \author :
+*/
+
 #include "Fonctions.h"
 
+/**
+ * \brief Permet de rechercher un adhérent
+ * \author :
+ * \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
+ * \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)
 {
     int i;
@@ -18,6 +33,15 @@ int RechercheAdherent(int tNoCarte[], int nbElem, int noCarte, int *trouve)
     }
 }
 
+/**
+ * \brief Ajoute des points sur une carte
+ * \author :
+ * \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 nbElem taille logique des tableaux
+ * \param noCarte numéro de la carte à créditer
+*/
 void AjoutPoints(int tNoCarte[], int tPointsCarte[], int tCarteActive[], int nbElem, int noCarte)
 {
     int pointsCarte, trouve, pas;
@@ -64,6 +88,14 @@ void AjoutPoints(int tNoCarte[], int tPointsCarte[], int tCarteActive[], int nbE
     }
 }
 
+/**
+ * \brief Débite une carte lorsqu'un adhérent pratique une activité
+ * \author :
+ * \param tNoCarte tableau contenant les numéros de toutes les cartes
+ * \param tCarteActive tableau qui contient 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
+*/
 void DebitActivitee(int tNoCarte[], int tCarteActive[], int tNbActivitesJour[], int nbElem)
 {
     int noCarte, trouve, pas, pointsCarte;

Global.c

@@ -1,3 +1,9 @@
+/**
+ * \file Global.c
+ * \brief Fichier qui contient la fonction de gestion des menus
+ * \author : 
+*/
+
 #include "Fonctions.h"
 
 /*
@@ -16,6 +22,10 @@ Attribution de points lors d'un sceance qui dépende de critères socioprofessio
 Votre application doit pouvoir interdire à un adhérent de fréquenter le centre plus d’une fois par jour
 */
 
+/**
+ * \brief Permet de gérer les menus en appelant une fonction pour chaque choix fait par l'utilisateur
+ * \author : 
+*/
 void GestionMenus(void)
 {
     int tNoCarte[20] = {0}, tAge[20] = {0}, tPointsCarte[20] = {0}, tCarteActive[20] = {0};

Menus.c

@@ -1,5 +1,16 @@
+/**
+ * \file Menus.c
+ * \brief Fichier qui contient les fonctions du menu
+ * \author :
+*/
+
 #include "Fonctions.h"
 
+/**
+ * \brief Affiche le menu principal et permet de choisir une option
+ * \author :
+ * \return le choix entré par l'utilisateur
+*/
 int ChoixMenu(void)
 {
     int choix;
@@ -17,6 +28,11 @@ int ChoixMenu(void)
     return choix;
 }
 
+/**
+ * \brief Affiche le menu d'affichage et permet de choisir une option
+ * \author :
+ * \return le choix entré par l'utilisateur
+*/
 int ChoixMenuAffichage(void)
 {
     char choix;