From aa85ea5a02d91f47f52f8cc2ce2e1cf953562b1f Mon Sep 17 00:00:00 2001
From: Romain Jegat <romain.jegat@insa-rennes.fr>
Date: Fri, 6 May 2016 16:26:52 +0200
Subject: [PATCH] Ajout de documentation Doxygen sur des fonctions
---
src/Interface.c | 9 ++++++++-
src/TerrainsXML.c | 11 +++++++++--
src/deplacements.c | 18 ++++++++++++++++--
src/terrain.c | 33 ++++++++++++++++++++++++++++-----
4 files changed, 61 insertions(+), 10 deletions(-)
diff --git a/src/Interface.c b/src/Interface.c
index efad5ec..bebe3b9 100644
--- a/src/Interface.c
+++ b/src/Interface.c
@@ -10,6 +10,14 @@
* \brief Fichier contenant le code des fonctions d'aquisition des classes.
*/
+
+/*!
+ * \fn Skins_GUI* Get_Skins_GUI(char *filename)
+ * \brief La fonction renvoie un tableau de skins relatifs à l'interface.
+ *
+ * \param Un nom de fichier xml.
+ * \return Un tableau de Skins_GUI.
+ */
Skins_GUI* Get_Skins_GUI(char *filename)
{
node_t *rootXML, *Interface, *Textures, *Skin;
@@ -40,6 +48,5 @@ Skins_GUI* Get_Skins_GUI(char *filename)
printf("Default vaut : %s\n",Textures_Interface[i].GUI_default);*/
/* ---- */
}
-
return Textures_Interface;
}
diff --git a/src/TerrainsXML.c b/src/TerrainsXML.c
index e7cdd14..c1d29b4 100644
--- a/src/TerrainsXML.c
+++ b/src/TerrainsXML.c
@@ -11,7 +11,15 @@
* \brief Fichier contenant le code des fonctions d'aquisition des terrains.
*/
-Terrain* Remplir_Terrains(FILE* Terrains_XML_log, char *filename) /* Remplit le tableau de cases à partir du fichier XML */
+
+/*!
+ * \fn Terrain* Remplir_Terrains(FILE* Terrains_XML_log, char *filename)
+ * \brief La fonction remplit le tableau de cases à partir d'un fichier XML.
+ *
+ * \param un pointeur sur un fichier, un nom de fichier.
+ * \return Un tableau de terrains.
+ */
+Terrain* Remplir_Terrains(FILE* Terrains_XML_log, char *filename)
{
fprintf(Terrains_XML_log,"I) Chargement du fichier Terrains XML - Definition des noeuds\n");
node_t *rootXML, *TerrainsXML;
@@ -177,7 +185,6 @@ Skins_Terrain * Load_Skins_Terrain(char *filename)
else
{
fprintf(stderr,"Impossible d'ouvrir le fichier Skins_XML_log");
-
}
}
diff --git a/src/deplacements.c b/src/deplacements.c
index 06d0fbd..113f3f7 100644
--- a/src/deplacements.c
+++ b/src/deplacements.c
@@ -10,7 +10,14 @@
* \brief Fichier contenant le code des fonctions liees aux déplacements des personnages.
*/
-boolean case_a_cote(Personnage * perso, Case * destination,int hauteur_case , int largeur_case){ /* vérifie que la case hexagonale "destination" est contigue à la case du personnage */
+/*!
+ * \fn boolean case_a_cote(Personnage * perso, Case * destination,int hauteur_case , int largeur_case)
+ * \brief La fonction vérifie que la case hexagonale "destination" est contigue à la case du personnage
+ *
+ * \param Un personnage, une case, deux entiers.
+ * \return Un booleen.
+ */
+boolean case_a_cote(Personnage * perso, Case * destination,int hauteur_case , int largeur_case){
Case *depart = getPosition(perso);
if (get_x(depart)>get_x(destination)+largeur_case||get_x(depart)<get_x(destination)-largeur_case||get_y(depart)>get_y(destination)+hauteur_case||get_y(depart)<get_y(destination)-hauteur_case){
return faux;
@@ -21,7 +28,14 @@ boolean case_a_cote(Personnage * perso, Case * destination,int hauteur_case , in
return vrai;
}
-int deplacement_unitaire(Personnage *perso,Case * destination, int hauteur_case , int largeur_case){ /*déplace un personnage sur une case située à côté de la sienne, si cela est possible */
+/*!
+ * \fn boolean case_a_cote(Personnage * perso, Case * destination,int hauteur_case , int largeur_case)
+ * \brief déplace un personnage sur une case située à côté de la sienne, si cela est possible
+ *
+ * \param Un personnage, une case, deux entiers.
+ * \return Un entier.
+ */
+int deplacement_unitaire(Personnage *perso,Case * destination, int hauteur_case , int largeur_case){
if (est_occupee(destination)){
printf("deplacement impossible : case deja occupee par un personnage\n");
return 1;
diff --git a/src/terrain.c b/src/terrain.c
index 7e135d6..76fbe0c 100644
--- a/src/terrain.c
+++ b/src/terrain.c
@@ -10,13 +10,25 @@
*/
-/* Procédure de remplissage des cases à partir d'un fichier XML */
+/*!
+ * \fn Terrain* Librairie_Terrains(char *filename)
+ * \brief Procédure de remplissage des cases à partir d'un fichier XML.
+ *
+ * \param Un nom de fichier XML.
+ * \return Un tableau de Terrains.
+ */
Terrain* Librairie_Terrains(char *filename)
{
return Remplir_Terrains_log(filename);
}
-/* Generation d'un fichier log decrivant le deroulement de la procedure d'aquisition des terrains */
+/*!
+ * \fn Terrain* Remplir_Terrains_log(char *filename)
+ * \brief Generation d'un fichier log decrivant le deroulement de la procedure d'aquisition des terrains.
+ *
+ * \param Un nom de fichier XML.
+ * \return Un tableau de Terrains.
+ */
Terrain* Remplir_Terrains_log(char *filename)
{
@@ -38,13 +50,24 @@ Terrain* Remplir_Terrains_log(char *filename)
}
}
-
-
-
+/*!
+ * \fn boolean terrain_franchissable(Terrain *t)
+ * \brief La fonction retourne le fait que le terrain soit franchissable ou non.
+ *
+ * \param Un pointeur sur un terrain.
+ * \return Un booleen.
+ */
boolean terrain_franchissable(Terrain *t){
return t->franchissable;
}
+/*!
+ * \fn Terrain * init_terrain(Terrain * t, char * n, boolean f, unsigned short int PD)
+ * \brief La fonction initialise un terrain.
+ *
+ * \param Un pointeur sur un terrain, une chaine de caracteres, un boolean, un entier.
+ * \return Un Terrain.
+ */
Terrain * init_terrain(Terrain * t, char * n, boolean f, unsigned short int PD){
t->franchissable=f;
strncpy(n,t->nomTerrain,TAILLE_NOMS-1);
--
GitLab