Ajout de documentation

structuresP2.c

@@ -1,10 +1,13 @@
+/**
+ * @file structuresP2.c
+ * @author Kyllian Chabanon - Antoine Perederii
+ * @brief Fichier contenant les fonctions des structures de la partie 2
+ */
 #include "SAE.h"
 
-// ListeChoix
-
 /**
  * @brief Retourne une nouvelle liste vide
- * 
+ *
  * @return ListeChoix La liste créée
  */
 ListeChoix listenouvChoix(void)
@@ -16,7 +19,7 @@ ListeChoix listenouvChoix(void)
 
 /**
  * @brief Insère un choix en tête de d'une liste
- * 
+ *
  * @param lc Liste de choix dans laquelle insérer
  * @param choix Choix à insérer
  * @return ListeChoix La liste de choix après insertion
@@ -37,7 +40,7 @@ ListeChoix insererEnTeteChoix(ListeChoix lc, Choix choix)
 
 /**
  * @brief Insère un nouveau choix dans une liste dans l'ordre alphabétique de la ville et du département
- * 
+ *
  * @param lc Liste de choix dans laquelle insérer
  * @param choix Choix à insérer
  * @return ListeChoix La liste de choix après insertion
@@ -60,7 +63,7 @@ ListeChoix insererChoix(ListeChoix lc, Choix choix)
 
 /**
  * @brief supprime le choix en tête d'une liste
- * 
+ *
  * @param lc Liste dans laquelle supprimer
  * @return ListeChoix La liste de choix après suppression
  */
@@ -79,8 +82,8 @@ ListeChoix supprimerEnTeteChoix(ListeChoix lc)
 }
 
 /**
- * @brief Supprime un choix particulier dans une liste 
- * 
+ * @brief Supprime un choix particulier dans une liste
+ *
  * @param lc Liste dans laquelle supprimer
  * @param choix Choix à supprimer
  * @return ListeChoix La liste de choix après suppression
@@ -103,7 +106,7 @@ ListeChoix supprimerChoix(ListeChoix lc, Choix choix)
 
 /**
  * @brief Recherche un choix dans une liste
- * 
+ *
  * @param lc Liste de choix dans laquelle rechercher
  * @param choix Choix à rechercher
  * @return true Si le choix a été trouvé
@@ -123,7 +126,7 @@ bool rechercheChoix(ListeChoix lc, Choix choix)
 
 /**
  * @brief Retourne le choix en tête de liste
- * 
+ *
  * @param lc Liste de choix
  * @return Choix Le choix en tête de la liste
  */
@@ -139,7 +142,7 @@ Choix TeteChoix(ListeChoix lc)
 
 /**
  * @brief Vérifie si une liste est vide
- * 
+ *
  * @param lc Liste de choix
  * @return true Si la liste est vide
  * @return false Si la liste n'est pas vide
@@ -151,7 +154,7 @@ bool videChoix(ListeChoix lc)
 
 /**
  * @brief Affiche tous les choix d'une liste
- * 
+ *
  * @param lc Liste de choix
  */
 void afficherChoix(ListeChoix lc)
@@ -166,7 +169,7 @@ void afficherChoix(ListeChoix lc)
 
 /**
  * @brief Retourne la longueur d'une liste de choix
- * 
+ *
  * @param lc Liste de choix
  * @return int La longueur de la liste de choix
  */
@@ -183,7 +186,7 @@ int longueurChoix(ListeChoix lc)
 
 /**
  * @brief Affiche un choix
- * 
+ *
  * @param choix Le choix à afficher
  */
 void afficherCandidatsChoix(Choix choix)
@@ -193,7 +196,7 @@ void afficherCandidatsChoix(Choix choix)
 
 /**
  * @brief Retourne le département d'un choix
- * 
+ *
  * @param lc Liste de choix
  * @param pos Position du choix duquel on veut retourner le département
  * @return char* Le département du choix
@@ -209,7 +212,7 @@ char *getDeptChoix(ListeChoix lc, int pos)
 
 /**
  * @brief Retourne la ville d'un choix
- * 
+ *
  * @param lc Liste de choix
  * @param pos Position du choix duquel on veut retourner le département
  * @return char* La ville du choix
@@ -225,7 +228,7 @@ char *getVilleChoix(ListeChoix lc, int pos)
 
 /**
  * @brief Modifie la décision d'un département
- * 
+ *
  * @param lc Liste de choix
  * @param pos Position du choix à modifier
  * @param val Nouvelle valeur de la décision du département
@@ -241,7 +244,7 @@ void setDecisionAdmission(ListeChoix lc, int pos, int val)
 
 /**
  * @brief Retourne la position dans la liste de choix d'un choix recherché
- * 
+ *
  * @param lc Liste de choix
  * @param ville Ville du choix à rechercher
  * @param dept Département du choix à rechercher