Doc

src/partie3/saeP3.h

@@ -1,3 +1,20 @@
+/**
+*\file saeP3.h
+*\brief Liste des fonctions utilisées dans la partie 3.
+*\author Van Brabant.J Champeau.Y
+*\date 13 janvier 2023
+*
+*Fichier regroupant les prototypes des fonctions utilisées par l'application dans la partie 3 de la SAE.
+*/
+
+
+/**
+* \brief Menu pour les reponsables de départements
+* \param [in] tiut tableau des IUTs.   
+* \param [in] tlogi taille logique de tiut tlogi;
+* \param [in] tcandidat tableau des candidats tcandidats. 
+* \return le tableau de candidats.
+*/
 void menuResponsable(VilleIUT* tiut[],int *tlogi,candidat* tcandidat[]);
     /*
     Menu pour les reponsables de départements
@@ -7,14 +24,22 @@ void menuResponsable(VilleIUT* tiut[],int *tlogi,candidat* tcandidat[]);
         tableau des candidats tcandidats. 
     Sortie : Aucune
     */ 
+
+/**
+* \brief Recherche l'ID du voeu en IUT Informatique à Clermont Ferrand pour un candidat et la renvoie.
+* \param [in] candid Candidat utilisé pour la recherche  
+* \param [out] ID du voeu dans le tableau   
+* \return le tableau de candidats.
+*/
 int RechercheVoeuIDInformatique(candidat candid);
-    /*
-    Recherche le voeu en informatique à Clermont Ferrand d'un candidat
-    Entrée : 
-        objet candidat candid;
-    Sortie : 
-        ID du Voeu dans le tableau
-    */
+
+
+/**
+* \brief Affiche toutes les candidatures.
+* \param [in] tcandidat tableau des candidats. 
+* \param [in] nbcandidat taille logique de tcandidat.
+* \return le tableau de candidats.
+*/
 void ShowCandid(candidat* tcandidat[],int tlogi);
     /*
     Affiche toutes les candidatures.
@@ -23,6 +48,13 @@ void ShowCandid(candidat* tcandidat[],int tlogi);
         taille logique de tcandidat nbcandidat;
     Sortie : Aucune
     */
+
+/**
+* \brief Gère l'entiéreté des fonctions d'admissions
+* \param [in] tcandidat tableau des candidats. 
+* \param [in] tlogi taille logique de tcandidat.
+* \return le tableau de candidats.
+*/
 void Admissions(candidat* tcandidat[],int tlogi);
     /*
     Gère l'entiéreté des fonctions d'admissions.
@@ -32,6 +64,23 @@ void Admissions(candidat* tcandidat[],int tlogi);
     Sortie : Aucune
     */
 
+
+/**
+* \brief Fusionne deux tableaux
+* \param [in] tabfusion1 Premier tableau à fusioner. 
+* \param [in] tlogi1 taille logique du premier tableau.
+* \param [in] tabfusion2 Deuxième tableau à fusioner. 
+* \param [in] tlogi2 taille logique du deuxième tableau.
+* \return le tableau de candidats.
+*/
 int* fusion(int* tabfusion1,int tlogi1, int* tabfusion2, int tlogi2);
 
+
+/**
+* \brief fonction chargeant le fichier des IUTs. 
+* \param [in] tabNote Tableau de Note calculé avec les coefficients
+* \param [in] tabIDCandidatAttente Tableau de candidats en liste d'attente.
+* \param [in] taille Taille des tableaux
+* \return le tableau de candidats.
+*/
 int* tri_fusion(int* tabNote, int* tabIDCandidatAttente, int taille);

src/partie4/saeP4.h

@@ -1,17 +1,31 @@
+/**
+*\file saeP4.h
+*\brief Liste des fonctions utilisées dans la partie 4.
+*\author Van Brabant.J Champeau.Y
+*\date 13 janvier 2023
+*
+*Fichier regroupant les prototypes des fonctions utilisées par l'application dans la partie 4 de la SAE.
+*/
+
+
+/**
+* \brief Affiche la liste de Voeux validés
+* \param [in] candid Candidat voulant la liste de ses voeux validés   
+*/
 void ListeVoeuValide(candidat candid);
-    /*
-    Affiche la liste de Voeu vaidé
-    Entrée : 
-        objet candidat candid;
-    Sortie : Aucune
-    */
+
+
+/**
+* \brief Permet au candidat de valider les décisions de départements
+* \param [in] candid Candidat voulant la liste de ses voeux validés   
+*/
 void Validation(candidat candid);
-    /*
-    Permet au candidat de valider les décisions de départements
-    Entrée : 
-        objet candidat candid;
-    Sortie : Aucune
-    */
+
+/**
+* \brief Recherche de manière Dichotomique un candidat dans la liste trié par ordre alphabétique
+* \param [in] ? 
+* \return ID du candidat dans le tableau
+*/
 int Recherche_Dichotomique();
     /*
     Recherche de manière Dichotomique un candidat dans la liste trié par ordre alphabétique
@@ -20,6 +34,13 @@ int Recherche_Dichotomique();
     Sortie : 
         ID du candidat dans le tableau
     */
+
+/**
+* \brief Recherche de manière Dichotomique un candidat dans la liste trié par ordre alphabétique
+* \param [in] tCandidAdmis Tableau des candidatsAdmis
+* \param [in] tlogi Taille logique du tableau TcandidAdmis
+* \return ID du candidat dans le tableau
+*/
 void AffichageAdmisAlphabetique(candidat* tCandidAdmis,int tlogi);
     /*
     Affiche les candidats admis dans l'ordre alphabétique.