From 9c3a2ce416f954e7f868851389751474c14df09b Mon Sep 17 00:00:00 2001
From: "yann.champeau" <Yann.CHAMPEAU@etu.uca.fr>
Date: Fri, 13 Jan 2023 14:15:22 +0100
Subject: [PATCH] Ajout de la documentation Doxygen.

---
 src/annexe/saeAnnexe.h | 61 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 60 insertions(+), 1 deletion(-)

diff --git a/src/annexe/saeAnnexe.h b/src/annexe/saeAnnexe.h
index b8d16a3..f6f270f 100644
--- a/src/annexe/saeAnnexe.h
+++ b/src/annexe/saeAnnexe.h
@@ -1,5 +1,20 @@
 //Initialisation de fonctions :
 
+/**
+*\file saeAnnexe.h
+*\brief Liste des fonctions générales utilisées dans la plupart des .c.
+*\author Van Brabant.J Champeau.Y
+*\date 13 janvier 2023
+*
+*Fichier regroupant les prototypes des fonctions générales utilisées par l'application.
+*/
+
+
+
+/**
+* \brief affiche le menu principal de l'application.
+* \param [in] CandidOpen Entier contenant 1 si la phase de canditatures est ouverte, 0 sinon.
+*/
 void menu(int CandidOpen);
     /*
     Affiche le menu
@@ -7,6 +22,14 @@ void menu(int CandidOpen);
         Booléen notifiant l'ouverture ou non des candidatures CandidOpen;
     Sortie : Aucune
     */
+
+
+
+/**
+* \brief fonction chargeant le fichier des IUTs. 
+* \param [out] tiut Tableau contenant les IUTs.
+* \return le nombre d'éléments chargés dans le tableau.
+*/
 int loadIUT(VilleIUT** tiut);
     /*
     Charge le tableau tiut
@@ -15,6 +38,14 @@ int loadIUT(VilleIUT** tiut);
     Sortie : 
         taille logique du tableau
     */
+
+
+
+/**
+* \brief sauvegarde le tableau d'IUTs dans le fichier.
+* \param [in] tiut Tableau contenant les IUTs.
+* \param [in] tlogi taille logique du tableau.
+*/
 void saveIUT(VilleIUT** tiut, int tlogi);
     /*
     Sauvegarde le tableau iut dans un fichier
@@ -23,6 +54,16 @@ void saveIUT(VilleIUT** tiut, int tlogi);
         taille logique du tableau tlogi;
     Sortie : Aucune
     */
+
+
+
+/**
+* \brief recherche un IUT dans le tableau d'IUTs.
+* \param [in] tab Tableau contenant les IUTs.
+* \param [in] lTab taille logique du tableau.
+* \param [in] mot nom de l'IUT à chercher.
+* \return -1 en cas d'erreur ou si l'IUT n'est pas trouvé, son indice dans le tableau sinon.
+*/
 int rechercheIUT(VilleIUT* tab[],int lTab,char mot[]);
     /*
     Cherche l'ID d'un IUT et le renvoie
@@ -37,6 +78,13 @@ int rechercheIUT(VilleIUT* tab[],int lTab,char mot[]);
 
 
 //Fonctions relatives aux listes chaînées :
+
+/**
+* \brief recherche si un département existe dans la liste de départements.
+* \param [in] liste liste des départements.
+* \param [in] dep nom du département à chercher.
+* \return 1 si le département existe, 0 sinon.
+*/
 int existeDep(MaillonDep* liste, char* dep);
     /*
     Regarde si un département existe dans la liste chainé
@@ -46,6 +94,14 @@ int existeDep(MaillonDep* liste, char* dep);
     Sortie : 
         Booléen d'existence.
     */
+
+
+
+/**
+* \brief calcule la longueur d'une liste de départements.
+* \param [in] liste liste de départements.
+* \return la longueur de \b liste .
+*/
 int longueurListe(MaillonDep* liste);
     /*
     Renvoie la longueur de la liste
@@ -54,9 +110,12 @@ int longueurListe(MaillonDep* liste);
     Sortie : 
         Longueur de la liste.
     */
+//-----------------------------------------------//
 
 
-
+/**
+* \brief réinitialise l'affichage.
+*/
 void reset(void);
     /*
     Permet d'effacer le menu actuel.