From a923052071669b80f318a49e6b265a65d1d995dc Mon Sep 17 00:00:00 2001
From: ColinDrieu <colin.drieu@insa-rennes.fr>
Date: Fri, 18 Mar 2016 18:15:24 +0100
Subject: [PATCH] Commentaire ajoutes sur le fichier structure.h
Commentaires ajoutes pour repondre a la syntaxe Doxygen
---
src/structures.h | 120 ++++++++++++++++++++++++++++++-----------------
1 file changed, 78 insertions(+), 42 deletions(-)
diff --git a/src/structures.h b/src/structures.h
index b4adc07..8f06b2b 100644
--- a/src/structures.h
+++ b/src/structures.h
@@ -1,7 +1,13 @@
+/* \file structures.h
+ * \brief Fichier contenant les principales structures.
+ */
+
#ifndef STRUCTURES_H_INCLUDED
#define STRUCTURES_H_INCLUDED
+/* \def TAILLE_MAX_CARTE */
#define TAILLE_MAX_CARTE 256
+/* \def TAILLE_NOMS */
#define TAILLE_NOMS 16
/* definition des structures nécessaires */
@@ -16,74 +22,104 @@
/* Competence */
-
+/* \enum boolean
+ * \brief Definition du type boolean.
+ * faux=0, vrai=1
+ */
typedef enum {faux, vrai} boolean;
+/* \struct Type_terrain structures.h
+ * \brief Definition de la structure Type_terrain
+ */
typedef struct {
- char nom[TAILLE_NOMS];
- boolean franchissable;
- boolean franchissable_sorts;
- unsigned short int PD_requis;
+ char nom[TAILLE_NOMS]; /*<Nom du terrain. */
+ boolean franchissable; /*<Le terrain est franchissable ou non par un personnage. */
+ boolean franchissable_sorts; /*<Le terrain est franchissable ou non par un sort. */
+ unsigned short int PD_requis; /*<Nombre de PD requis pour traverser le terrain. */
}Type_terrain;
-
+/* \struct Case structures.h
+ * \brief Definition de la structure Case
+ */
typedef struct Case{
- unsigned short int coord_x;
- unsigned short int coord_y;
- Type_terrain *terrain;
- boolean occupee;
+ unsigned short int coord_x; /*<Abscisse de la case*/
+ unsigned short int coord_y; /*<Ordonnee de la case*/
+ Type_terrain *terrain; /*<Le type de terrain de la case*/
+ boolean occupee; /*<La case est occupee ou non par un personnage*/
} Case;
+/* \typedef carte structures.h
+ * \brief Definition du type Carte
+ * La carte est un tableau de Case de taille TAILLE_MAX_CARTE.
+ */
typedef Case carte[TAILLE_MAX_CARTE];
+/* \struct Case structures.h
+ * \brief Definition de la structure Attaque.
+ */
typedef struct {
- char nom[TAILLE_NOMS];
- unsigned short int degats_directs;
- unsigned short int degats_permanents;
- unsigned short int portee;
- Effet effets[];
+ char nom[TAILLE_NOMS]; /*<Nom de l'attaque de taille TAILLE_NOMS*/
+ unsigned short int degats_directs; /*<Degats direct occasionnes*/
+ unsigned short int degats_permanents; /*<Degats permanents occasionnes*/
+ unsigned short int portee; /*<Portee en nombre de cases de l'attaque*/
+ Effet effets[]; /*<Tableau des effets appliques par l'attaque*/
} Attaque;
-
+/* \struct Classee structures.h
+ * \brief Definition de la structure Classe.
+ */
typedef struct {
- char nom[TAILLE_NOMS];
- Attaque* attaques;
- unsigned short int points_deplacement_max;
- unsigned short int PV_max;
- unsigned short int mana_max;
+ char nom[TAILLE_NOMS]; /*<Nom de la classe de taille TAILLE_NOMS*/
+ Attaque* attaques; /*<Les attaques disponibles pour la classe*/
+ unsigned short int points_deplacement_max; /*<Les PD maximums accordés a la classe*/
+ unsigned short int PV_max; /*<Les PV maximums accordés a la classe*/
+ unsigned short int mana_max; /*<Le mana maximum accordé a la classe*/
} Classe;
+/* \struct Personnage structures.h
+ * \brief Definition de la structure Personnage.
+ */
typedef struct {
- char nom[TAILLE_NOMS];
- Classe classe;
- unsigned short int points_deplacement;
- unsigned short int PV;
- unsigned short int mana;
- Case *position;
- Effet effets[];
+ char nom[TAILLE_NOMS];/*<Nom du personnage de taille TAILLE_NOMS*/
+ Classe classe; /*<La classe dont depend le personnage */
+ unsigned short int points_deplacement; /*<Les PD actuels du personnage*/
+ unsigned short int PV; /*<Les PV actuels du personnage*/
+ unsigned short int mana; /*<Le mana actuel du personnage*/
+ Case *position; /*<La case representant la position actuelle du personnage*/
+ Effet effets[]; /*<Un tableau d'effets representant les effets affectant le personnage*/
} Personnage;
+/* \struct Personnage structures.h
+ * \brief Definition de la structure Personnage.
+ */
typedef struct {
- unsigned int nb_tours_restants;
- unsigned int valeur_degats_duree;
- unsigned int valeur_soin_duree;
- boolean paralysie;
+ unsigned int nb_tours_restants;/*<Le nombre de tours restants avant que l'effet ne s'estompe*/
+ unsigned int valeur_degats_duree; /*<Le nombre de degat de duree subit par tour*/
+ unsigned int valeur_soin_duree; /*<Le nombre PV regeneres par tour*/
+ boolean paralysie; /*<L'effet provoque ou non une paralysie*/
} Effet;
-
+/* \struct Competence structures.h
+ * \brief Definition de la structure Competences.
+ * Les competences sont representees sous forme d'arbre chaque
+ * parent ayant 2 enfants.
+ */
typedef struct competence{
- unsigned short int id;
- char nom[TAILLE_NOMS];
- unsigned short int etage;
- struct competence *enfant_gauche;
- struct competence *enfant_droit;
- struct effet_competence *effet;
- boolean connu;
+ unsigned short int id; /*<Un entier qui represente la competence*/
+ char nom[TAILLE_NOMS]; /*<Nom de la competence de taille TAILLE_NOMS*/
+ unsigned short int etage; /*<Etage de la competence dans l'arbre*/
+ struct competence *enfant_gauche; /*<Pointeur vers le premier enfant de la competence*/
+ struct competence *enfant_droit; /*<Pointeur vers le deuxieme enfant de la competence*/
+ struct effet_competence *effet; /*<Pointeur vers les effets de la competence*/
+ boolean connu; /*<La competence est connue ou non*/
}Competence;
+/* \struct effet_competence structures.h
+ * \brief Definition de la structure effet_competence
+ */
typedef struct effet_competence{
- unsigned short int id;
- char nom[TAILLE_NOMS];
+ unsigned short int id; /*<Un entier qui represente la competence*/
+ char nom[TAILLE_NOMS]; /*<Nom de la competence de taille TAILLE_NOMS*/
/* effets à définir */
}effet_competence;
--
GitLab