P1 2 3 4 doc

src/partie1/saeP1.c

@@ -9,15 +9,6 @@
 
 void menuUser(VilleIUT* lvIUT[],int tlogi, int CandidOpen, candidat* tcandidat[])
 {
-    /*
-    Menu pour les utilisateurs du système, les candidats.
-    Entrée : 
-        Tableau des IUT tiut;
-        taille logique de tiut tlogi;
-        Booléen gérant l'ouverture ou non des candidatures CandidOpen; 
-        tableau des candidats tcandidats. 
-    Sortie : Aucune
-    */
     int quit=0, ck=0, act;
     while(!quit)
     {
@@ -83,25 +74,11 @@ void menuUser(VilleIUT* lvIUT[],int tlogi, int CandidOpen, candidat* tcandidat[]
 
 void SearchCityWithIUT(VilleIUT* lvIUT[], int tlogi)
 {
-    /*
-    Affiche toute les villes possèdant un IUT
-    Entrée : 
-        Tableau des IUT tiut;
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     for (int i=0;i<tlogi;++i) printf("\n - %s",lvIUT[i]->Ville);
 }
 
 void DepEachIUT(VilleIUT* lvIUT[], int tlogi)
 {
-    /*
-    Affiche toute les villes possèdant un IUT et leurs départements
-    Entrée : 
-        Tableau des IUT tiut;
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     for (int i=0;i<tlogi;++i)
     {
         printf("\n - %s :\n",lvIUT[i]->Ville);
@@ -116,14 +93,6 @@ void DepEachIUT(VilleIUT* lvIUT[], int tlogi)
 
 void SearchPlaceFromDepInIUT(VilleIUT* lvIUT[],int tlogi)
 {
-    /*
-    Affiche le nombre de place d'un département précis dans un iut précis.
-    Les deux sont entrées par l'utilisateur.
-    Entrée : 
-        Tableau des IUT tiut;
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     char sVille[31];
     char sDep[31];
     int boolF=0, i;
@@ -167,13 +136,6 @@ void SearchPlaceFromDepInIUT(VilleIUT* lvIUT[],int tlogi)
 
 void SearchIUTFromDep(VilleIUT* lvIUT[],int tlogi)
 {
-    /*
-    Affiche toutes les villes possèdant le département entrée par l'utilisateur.
-    Entrée : 
-        Tableau des IUT tiut;
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     char sDep[31];
     printf("\nMerci de renseignez le département dont vous cherchez les IUTs :\n");
     scanf("%s",sDep);
@@ -191,14 +153,6 @@ void SearchIUTFromDep(VilleIUT* lvIUT[],int tlogi)
 //Partie Administrateur.
 
 void menuAdmin(VilleIUT* tiut[],int *tlogi, int* CandidOpen){
-    /*
-    Menu pour les administrateurs du système.
-    Entrée : 
-        Tableau des IUT tiut; 
-        taille logique de tiut tlogi;
-        booléen indiquant l'ouverture ou fermeture des candidature CandidOpen;
-    Sortie : Aucune
-    */
 	int quit=0, ck=0, act;
 	while(!quit){
 		printf("#--------------------------------------------------------------------#\n");
@@ -263,13 +217,6 @@ void menuAdmin(VilleIUT* tiut[],int *tlogi, int* CandidOpen){
 }
 
 void modifPlaces(VilleIUT* tiut[],int tlogi){
-    /*
-    Permet de modifier les places d'un département dans un IUT.
-    Entrée : 
-        Tableau des IUT tiut; 
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     printf("\nEntrez la ville correspondant à l'IUT à modifier (Q pour abandonner): ");
     char ville[31];
     scanf("%s",ville);
@@ -298,13 +245,6 @@ void modifPlaces(VilleIUT* tiut[],int tlogi){
 }
 
 void creerDep(VilleIUT* tiut[],int tlogi){
-    /*
-    Permet de créer un département dans un IUT.
-    Entrée : 
-        Tableau des IUT tiut; 
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     printf("\nEntrez la ville correspondant à l'IUT à modifier (Q pour abandonner): ");
     char ville[31];
     scanf("%s",ville);
@@ -353,13 +293,6 @@ void creerDep(VilleIUT* tiut[],int tlogi){
 }
 
 void supprimerDep(VilleIUT* tiut[],int tlogi){
-    /*
-    Permet de supprimer un département dans un IUT.
-    Entrée : 
-        Tableau des IUT tiut; 
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     printf("\nEntrez la ville correspondant à l'IUT à modifier (Q pour abandonner): ");
     char ville[31];
     scanf("%s",ville);
@@ -402,13 +335,6 @@ void supprimerDep(VilleIUT* tiut[],int tlogi){
 }
 
 void modifNomResponsable(VilleIUT* tiut[],int tlogi){
-    /*
-    Permet de modifier le nom d'un responsable d'un département d'un IUT.
-    Entrée : 
-        Tableau des IUT tiut; 
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
     printf("\nEntrez la ville correspondant à l'IUT à modifier (Q pour abandonner): ");
     char ville[31];
     scanf("%s",ville);
@@ -437,13 +363,6 @@ void modifNomResponsable(VilleIUT* tiut[],int tlogi){
 }
 
 void creerIUT(VilleIUT* tiut[],int* tlogi){
-    /*
-    Permet de créer un IUT (quand elle segfault pas.)
-    Entrée : 
-        Tableau des IUT tiut; 
-        taille logique de tiut tlogi;
-    Sortie : Aucune
-    */
 	printf("\nEntrez le nom de la ville correspondant à l'IUT à ajouter (Q pour abandonner): ");
 	char ville[31];
 	scanf("%*c%s",ville);

src/partie1/saeP1.h

@@ -19,25 +19,97 @@ typedef struct
 //Consultant
 
 void menuUser(VilleIUT* lvIUT[],int tlogi, int CandidOpen, candidat *tcandidat[]);
-
+    /*
+    Menu pour les utilisateurs du système, les candidats.
+    Entrée : 
+        Tableau des IUT tiut;
+        taille logique de tiut tlogi;
+        Booléen gérant l'ouverture ou non des candidatures CandidOpen; 
+        tableau des candidats tcandidats. 
+    Sortie : Aucune
+    */
 void SearchCityWithIUT(VilleIUT* lvIUT[], int tlogi);
-
+    /*
+    Affiche toute les villes possèdant un IUT
+    Entrée : 
+        Tableau des IUT tiut;
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void DepEachIUT(VilleIUT* lvIUT[], int tlogi);
-
+    /*
+    Affiche toute les villes possèdant un IUT et leurs départements
+    Entrée : 
+        Tableau des IUT tiut;
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void SearchPlaceFromDepInIUT(VilleIUT* lvIUT[],int tlogi);
-
+    /*
+    Affiche le nombre de place d'un département précis dans un iut précis.
+    Les deux sont entrées par l'utilisateur.
+    Entrée : 
+        Tableau des IUT tiut;
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void SearchIUTFromDep(VilleIUT* lvIUT[],int tlogi);
+    /*
+    Affiche toutes les villes possèdant le département entrée par l'utilisateur.
+    Entrée : 
+        Tableau des IUT tiut;
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 
 //Admin
 
 void menuAdmin(VilleIUT* tiut[],int* tlogi,int* CandidOpen);
-
+    /*
+    Menu pour les administrateurs du système.
+    Entrée : 
+        Tableau des IUT tiut; 
+        taille logique de tiut tlogi;
+        booléen indiquant l'ouverture ou fermeture des candidature CandidOpen;
+    Sortie : Aucune
+    */
 void modifPlaces(VilleIUT* tiut[],int tlogi);
-
+    /*
+    Permet de modifier les places d'un département dans un IUT.
+    Entrée : 
+        Tableau des IUT tiut; 
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void creerDep(VilleIUT* tiut[],int tlogi);
-
+    /*
+    Permet de créer un département dans un IUT.
+    Entrée : 
+        Tableau des IUT tiut; 
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void supprimerDep(VilleIUT* tiut[],int tlogi);
-
+    /*
+    Permet de supprimer un département dans un IUT.
+    Entrée : 
+        Tableau des IUT tiut; 
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void modifNomResponsable(VilleIUT* tiut[],int tlogi);
-
+    /*
+    Permet de modifier le nom d'un responsable d'un département d'un IUT.
+    Entrée : 
+        Tableau des IUT tiut; 
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */
 void creerIUT(VilleIUT* tiut[],int* tlogi);
+    /*
+    Permet de créer un IUT (quand elle segfault pas.)
+    Entrée : 
+        Tableau des IUT tiut; 
+        taille logique de tiut tlogi;
+    Sortie : Aucune
+    */

src/partie2/saeP2.h

@@ -17,8 +17,47 @@ typedef struct
 }candidat;
 
 candidat* LoadCandid(int *CandidOpen,int* nbcandidat);
+    /*
+    Charge le fichier candidature
+    Entrée : 
+        Booléen Candidature par adresse pour lire la valeur dans le fichier CandidOpen;
+        taille logique du tableau de candidat nbcandidat;
+    Sortie : 
+        tableau des candidats.
+    */
 void SaveCandid(int nbcandidat,candidat *tcandidat,int CandidOpen);
+    /*
+    Sauvegarde le fichier candidature
+    Entrée : 
+        taille logique de tcandidat nbcandidat;
+        tableau des candidats tcandidats. 
+        Booléen gérant l'ouverture ou non des candidatures CandidOpen; 
+    Sortie : Aucune
+    */
 void RechercheCandidat(int ID, int nbcandidat,candidat* tcandidat);
+    /*
+    Recherche et affiche un candidat selon son ID
+    Entrée : 
+        ID du candidat ID;
+        taille logique de tcandidat nbcandidat;
+        tableau des candidats tcandidats. 
+    Sortie : Aucune
+    */
 void ListeCandidat(int nbcandidat,candidat *tcandidat);
+    /*
+    Liste tout les candidats.
+    Entrée : 
+        taille logique de tcandidat nbcandidat;
+        tableau des candidats tcandidats. 
+    Sortie : Aucune
+    */
 void Candidater(VilleIUT* tiut[],int *tlogi, candidat* tcandidat,int numcandid);
-//void gestionPhaseCandidatures(); A FAIRE.
+    /*
+    Permet de candidater dans un IUT
+    Entrée : 
+        Tableau des IUT tiut;
+        taille logique de tiut tlogi;
+        Booléen gérant l'ouverture ou non des candidatures CandidOpen; 
+        tableau des candidats tcandidats. 
+    Sortie : Aucune
+    */

src/partie3/saeP3.h

@@ -1,4 +1,33 @@
 void menuResponsable(VilleIUT* tiut[],int *tlogi,candidat* tcandidat[]);
+    /*
+    Menu pour les reponsables de départements
+    Entrée : 
+        tableau des IUTs tiut;
+        taille logique de tiut tlogi;
+        tableau des candidats tcandidats. 
+    Sortie : Aucune
+    */ 
 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
+    */
 void ShowCandid(candidat* tcandidat[],int tlogi);
+    /*
+    Affiche toutes les candidatures.
+    Entrée : 
+        tableau des candidats tcandidats. 
+        taille logique de tcandidat nbcandidat;
+    Sortie : Aucune
+    */
 void Admissions(candidat* tcandidat[],int tlogi);
+    /*
+    Gère l'entiéreté des fonctions d'admissions.
+    Entrée : 
+        tableau des candidats tcandidats. 
+        taille logique de tcandidat nbcandidat;
+    Sortie : Aucune
+    */

src/partie4/saeP4.h

@@ -1,4 +1,30 @@
 void ListeVoeuValide(candidat candid);
+    /*
+    Affiche la liste de Voeu vaidé
+    Entrée : 
+        objet candidat candid;
+    Sortie : Aucune
+    */
 void Validation(candidat candid);
-void Recherche_Dichotomique();
+    /*
+    Permet au candidat de valider les décisions de départements
+    Entrée : 
+        objet candidat candid;
+    Sortie : Aucune
+    */
+int Recherche_Dichotomique();
+    /*
+    Recherche de manière Dichotomique un candidat dans la liste trié par ordre alphabétique
+    Entrée : 
+
+    Sortie : 
+        ID du candidat dans le tableau
+    */
 void AffichageAdmisAlphabetique(candidat* tCandidAdmis,int tlogi);
+    /*
+    Affiche les candidats admis dans l'ordre alphabétique.
+    Entrée : 
+        tableau des candidats tCandidAdmis. 
+        taille logique de tcandidAdmis tlogi;
+    Sortie : Aucune
+    */