diff --git a/src/ClassesXML.c b/src/ClassesXML.c index acc5858c7e8053cb074d212307031a1fa973e317..f9cc9102a80be1a3c255a7dec91b9fce8fb2ac18 100644 --- a/src/ClassesXML.c +++ b/src/ClassesXML.c @@ -4,8 +4,10 @@ #include "ClassesXML.h" - - +/*! +* \file classesXML.c +* \brief Fichier contenant le code des fonctions d'aquisition des classes. +*/ Classe* Remplir_Classes(FILE* Classes_log, const char *filename) /* Remplit le tableau de classes à partir du fichier XML */ { diff --git a/src/ClassesXML.h b/src/ClassesXML.h index 48fc88c8ea0ae7dde3311f9bb76fcbd44a6dd5f6..1e8dd035deac54cb37abbeabfc642338ddf5baec 100644 --- a/src/ClassesXML.h +++ b/src/ClassesXML.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a l'aquisition des classes. +*/ + #ifndef CLASSESXML_H_INCLUDED #define CLASSESXML_H_INCLUDED diff --git a/src/SDL.c b/src/SDL.c index 4f281fd99fde43455ff94d7ef01239ee9341025f..0e09f12b9d6b5d81126a78591aee046883b94707 100644 --- a/src/SDL.c +++ b/src/SDL.c @@ -7,6 +7,10 @@ #define HAUTEUR_CASE 71 #define NB_PERSO 1 +/*! +* \file SDL.c +* \brief Fichier contenant le code des fonctions liees à l'affichage par la SDL. +*/ int main_SDL() { diff --git a/src/SDL.h b/src/SDL.h index 2eefcb96d0ce016d5f12020d0a735999a48de054..2724b332a1ba6b71f7debd056e60c1634dcdc5e1 100644 --- a/src/SDL.h +++ b/src/SDL.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a l'affichage par SDL. +*/ + #ifndef SDL_H_INCLUDED #define SDL_H_INCLUDED diff --git a/src/TerrainsXML.c b/src/TerrainsXML.c index e121b776e357384e248dc5683216a4b1f9edc0c8..199fafda3a5b84c22e1e55205c04202ec7d65b30 100644 --- a/src/TerrainsXML.c +++ b/src/TerrainsXML.c @@ -3,6 +3,11 @@ #include "TerrainsXML.h" +/*! +* \file classesXML.c +* \brief Fichier contenant le code des fonctions d'aquisition des terrains. +*/ + Case* Remplir_Terrains(FILE* Terrains_XML_log, const char *filename) /* Remplit le tableau de cases à partir du fichier XML */ { fprintf(Terrains_XML_log,"I) Chargement du fichier Terrains XML - Definition des noeuds\n"); diff --git a/src/TerrainsXML.h b/src/TerrainsXML.h index 75a8ec6276338acd38ab1923f98ac09bad2ef1d7..cff21e79a9aee924f12739dba3760eb1a88750c3 100644 --- a/src/TerrainsXML.h +++ b/src/TerrainsXML.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a l'aquisition des types de terrains. +*/ + #ifndef TERRAINS_XML_H_INCLUDED #define TERRAINS_XML_H_INCLUDED diff --git a/src/carte.c b/src/carte.c index 5a0f41c5457500bed0222e4bd7916fa8f8ce9849..f26fc64231d0da31e71d66ccab93a7b2406a57b6 100644 --- a/src/carte.c +++ b/src/carte.c @@ -1 +1,6 @@ #include "carte.h" + +/*! +* \file carte.c +* \brief Fichier contenant le code des fonctions liees aux cartes. +*/ diff --git a/src/carte.h b/src/carte.h index a9016896d34226a6631112f260a9209885193e87..8ab25c14e2c778d20ebf4b85535e7590632b02dd 100644 --- a/src/carte.h +++ b/src/carte.h @@ -1,3 +1,9 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a la structure carte. +*/ + + #ifndef CARTE_H_INCLUDED #define CARTE_H_INCLUDED diff --git a/src/case.c b/src/case.c index 425e028a4d843e5619693edb406f46c60f50e8f4..f3f078982bed101bd51eacc573615564e6ba2784 100644 --- a/src/case.c +++ b/src/case.c @@ -5,6 +5,11 @@ #include "personnage.h" #include "deplacements.h" +/*! +* \file case.c +* \brief Fichier contenant le code des fonctions liees aux cases +*/ + Case * init_case(Case * c,int x, int y, Terrain *t){ c->coord_x=x; diff --git a/src/case.h b/src/case.h index 8d1a6437dd9f5f8b35a8fa2e952d92c11e2a2476..a26b52ef37812a024537a61759d50d72bad61747 100644 --- a/src/case.h +++ b/src/case.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a la structure case. +*/ + #ifndef CASE_H_INCLUDED #define CASE_H_INCLUDED diff --git a/src/classe.c b/src/classe.c index 4b32b34ab07ca0c5f0bcf1858b2d1ee259b81a72..240ad175662cabc3e36b62646a96f7323e109b94 100644 --- a/src/classe.c +++ b/src/classe.c @@ -3,7 +3,10 @@ #include <roxml.h> #include "classe.h" - +/*! +* \file classe.c +* \brief Fichier contenant le code des fonctions liees aux classes. +*/ Classe* Librairie_Classes(const char *filename){ diff --git a/src/classe.h b/src/classe.h index 141d52137476c5ff3eea690c177a5447d0d3c21a..db462d456f154e32b884c281f7b8398c123de2fd 100644 --- a/src/classe.h +++ b/src/classe.h @@ -1,3 +1,9 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a la structure classe. +*/ + + #ifndef CLASSE_H_INCLUDED #define CLASSE_H_INCLUDED diff --git a/src/competence.c b/src/competence.c index b1300980221f2b92d5a788064e10129a83787ac2..dc14ff165987857c136fca0ff776b9ee9675934f 100644 --- a/src/competence.c +++ b/src/competence.c @@ -3,6 +3,10 @@ #include "structures.h" #include "competence.h" +/*! +* \file competence.c +* \brief Fichier contenant le code des fonctions liees aux arbres de compétences. +*/ Arbre_Competence* init_arbre_competence(Arbre_Competence *a){ return NULL; diff --git a/src/competence.h b/src/competence.h index fd3d3758fc5dffafcf2c15bed16c931108385a2a..226e6c32b83c78a4d7a7fd5aed8096a642dca138 100644 --- a/src/competence.h +++ b/src/competence.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a la structure competence. +*/ + #ifndef DEPLACEMENTS_H_INCLUDED #define DEPLACEMENTS_H_INCLUDED diff --git a/src/deplacements.c b/src/deplacements.c index d39dd4a0927e2203beec15aa8537d17aec0a1860..117b8104592c72cf75bd3b4402bbf5e436ac703d 100644 --- a/src/deplacements.c +++ b/src/deplacements.c @@ -5,6 +5,11 @@ #include "personnage.h" #include "deplacements.h" +/*! +* \file deplacements.c +* \brief Fichier contenant le code des fonctions liees aux déplacements des personnages. +*/ + boolean case_a_cote(Personnage * perso, Case * destination){ /* vérifie que la case hexagonale "destination" est contigue à la case du personnage */ Case *depart = getPosition(perso); if (get_x(depart)>get_x(destination)+1||get_x(depart)<get_x(destination)-1||get_y(depart)>get_y(destination)+1||get_y(depart)>get_y(destination)-1){ diff --git a/src/deplacements.h b/src/deplacements.h index c2d0d8a8d185307dec0d52872ec2f67f76334ceb..0db414b5d140149076731ce42e0433d6b96b95d1 100644 --- a/src/deplacements.h +++ b/src/deplacements.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees aux deplacements des personnages. +*/ + #ifndef DEPLACEMENTS_H_INCLUDED #define DEPLACEMENTS_H_INCLUDED diff --git a/src/personnage.c b/src/personnage.c index 582da4e94cd06e3806c60deeb73893d2aa8b653d..830a1152d53d672eb81fde7bd13acba66c6af0cd 100644 --- a/src/personnage.c +++ b/src/personnage.c @@ -5,6 +5,11 @@ #include "personnage.h" #include "deplacements.h" +/*! +* \file personnage.c +* \brief Fichier contenant le code des fonctions liees aux personnages. +*/ + Personnage* init_personnage(Personnage *perso, Classe *c, Case *casedepart){ perso->classe=c; perso->points_deplacement=c->points_deplacement_max; diff --git a/src/personnage.h b/src/personnage.h index 70c641620f6e43778b96df7e399d007cc77c5150..4c654da17142a3ed688219f9e45ac4ac72543526 100644 --- a/src/personnage.h +++ b/src/personnage.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a la structure personnage. +*/ + #ifndef PERSONNAGE_H_INCLUDED #define PERSONNAGE_H_INCLUDED diff --git a/src/terrain.c b/src/terrain.c index dea7bed32f6d43311ea52626894e456f1635d5c0..83fb58f021b8e55e67f145a1c38a6528b7d46d32 100644 --- a/src/terrain.c +++ b/src/terrain.c @@ -3,6 +3,11 @@ #include <string.h> #include "terrain.h" +/*! +* \file joueurList.c +* \brief Fichier contenant le code des fonctions liees aux types de terrains. +*/ + /* Procédure de remplissage des cases à partir d'un fichier XML */ Terrain* Librairie_Terrains(const char *filename) diff --git a/src/terrain.h b/src/terrain.h index 5cf4d6f78238f52b02132f296f0f8d153357f6a0..139b63a658a250fc0e08a07103f28f7187728360 100644 --- a/src/terrain.h +++ b/src/terrain.h @@ -1,3 +1,8 @@ +/*! +* \file AffichageConsole.h +* \brief Fichier contenant les signatures des fonctions liees a la structure terrain. +*/ + #ifndef CLASSE_H_INCLUDED #define CLASSE_H_INCLUDED