From 5aae9a7e23cd05ddf8fd5a14339ac749f2edc343 Mon Sep 17 00:00:00 2001
From: Romain Jegat <romain.jegat@insa-rennes.fr>
Date: Wed, 20 Apr 2016 20:47:45 +0200
Subject: [PATCH] =?UTF-8?q?Ajout=20de=20la=20premi=C3=A8re=20ligne=20de=20?=
 =?UTF-8?q?documentation=20pour=20chaque=20fichier?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/ClassesXML.c   | 6 ++++--
 src/ClassesXML.h   | 5 +++++
 src/SDL.c          | 4 ++++
 src/SDL.h          | 5 +++++
 src/TerrainsXML.c  | 5 +++++
 src/TerrainsXML.h  | 5 +++++
 src/carte.c        | 5 +++++
 src/carte.h        | 6 ++++++
 src/case.c         | 5 +++++
 src/case.h         | 5 +++++
 src/classe.c       | 5 ++++-
 src/classe.h       | 6 ++++++
 src/competence.c   | 4 ++++
 src/competence.h   | 5 +++++
 src/deplacements.c | 5 +++++
 src/deplacements.h | 5 +++++
 src/personnage.c   | 5 +++++
 src/personnage.h   | 5 +++++
 src/terrain.c      | 5 +++++
 src/terrain.h      | 5 +++++
 20 files changed, 98 insertions(+), 3 deletions(-)

diff --git a/src/ClassesXML.c b/src/ClassesXML.c
index acc5858..f9cc910 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 48fc88c..1e8dd03 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 4f281fd..0e09f12 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 2eefcb9..2724b33 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 e121b77..199fafd 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 75a8ec6..cff21e7 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 5a0f41c..f26fc64 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 a901689..8ab25c1 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 425e028..f3f0789 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 8d1a643..a26b52e 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 4b32b34..240ad17 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 141d521..db462d4 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 b130098..dc14ff1 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 fd3d375..226e6c3 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 d39dd4a..117b810 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 c2d0d8a..0db414b 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 582da4e..830a115 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 70c6416..4c654da 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 dea7bed..83fb58f 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 5cf4d6f..139b63a 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
 
-- 
GitLab