From c7281da9785ef1b9caa9bf51570007ef3ab08655 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matt=C3=A9o=20Delabre?= <contact@matteodelabre.me>
Date: Mon, 18 Apr 2016 12:11:24 +0200
Subject: [PATCH] =?UTF-8?q?Am=C3=A9lioration=20de=20la=20documentation=20d?=
 =?UTF-8?q?es=20classes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 include/block.hpp         | 6 ++++++
 include/finish_block.hpp  | 5 +++++
 include/gravity_block.hpp | 6 ++++++
 include/kill_block.hpp    | 4 ++++
 include/object.hpp        | 5 +++++
 include/player.hpp        | 5 +++++
 include/switch_block.hpp  | 5 +++++
 include/utility.hpp       | 3 +++
 8 files changed, 39 insertions(+)

diff --git a/include/block.hpp b/include/block.hpp
index 0b87328..f08cb82 100644
--- a/include/block.hpp
+++ b/include/block.hpp
@@ -9,6 +9,12 @@ class Game;
 class ResourceManager;
 class Level;
 
+/**
+ * Un bloc est un objet du jeu à boîte englobante carrée.
+ * Il permet de réaliser des structures simples encadrant
+ * les joueurs. Il sert de base aux blocs réalisant des
+ * actions lorsqu'ils sont activés
+ */
 class Block : public Object {
 public:
     typedef std::shared_ptr<Block> Ptr;
diff --git a/include/finish_block.hpp b/include/finish_block.hpp
index 8ec6f8f..d36f73b 100644
--- a/include/finish_block.hpp
+++ b/include/finish_block.hpp
@@ -7,6 +7,11 @@
 
 class Game;
 
+/**
+ * Le bloc d'arrivée est un bloc spécial qui tue les joueurs
+ * qui arrivent dessus et fait gagner le niveau lorsqu'il n'y a
+ * plus de joueurs
+ */
 class FinishBlock : public Block {
 public:
     typedef std::shared_ptr<FinishBlock> Ptr;
diff --git a/include/gravity_block.hpp b/include/gravity_block.hpp
index 4d2e077..63005af 100644
--- a/include/gravity_block.hpp
+++ b/include/gravity_block.hpp
@@ -8,6 +8,12 @@
 class Game;
 enum class GravityDirection;
 
+/**
+ * Le bloc de gravité est un bloc spécial qui change l'orientation
+ * de la gravité dans une direction prédéfinie lorsqu'il est
+ * activé par n'importe quel objet. Ce bloc ne peut être utilisé
+ * qu'une seule fois par partie
+ */
 class GravityBlock : public Block {
 public:
     typedef std::shared_ptr<GravityBlock> Ptr;
diff --git a/include/kill_block.hpp b/include/kill_block.hpp
index a9f036f..41dda6a 100644
--- a/include/kill_block.hpp
+++ b/include/kill_block.hpp
@@ -7,6 +7,10 @@
 
 class Game;
 
+/**
+ * Le bloc tueur est un bloc spécial qui tue les joueurs
+ * qui arrivent dessus et fait perdre la partie
+ */
 class KillBlock : public Block {
 public:
     typedef std::shared_ptr<KillBlock> Ptr;
diff --git a/include/object.hpp b/include/object.hpp
index 58edc62..e3b9002 100644
--- a/include/object.hpp
+++ b/include/object.hpp
@@ -9,6 +9,11 @@
 class Level;
 class Game;
 
+/**
+ * Représente de manière abstraite un des objets du jeu.
+ * Les classes descendantes doivent notamment implémenter la
+ * méthode d'activation, de dessin et de boîte englobante
+ */
 class Object : public std::enable_shared_from_this<Object> {
 public:
     typedef std::shared_ptr<Object> Ptr;
diff --git a/include/player.hpp b/include/player.hpp
index f3671bf..22c2be3 100644
--- a/include/player.hpp
+++ b/include/player.hpp
@@ -5,6 +5,11 @@
 #include <memory>
 #include "object.hpp"
 
+/**
+ * Le joueur est un objet du jeu qui peut être déplacé au clavier
+ * et interagit avec les autres objets. Il possède un statut particulier
+ * au sein du niveau car il détermine si l'on gagne ou on perd la partie
+ */
 class Player : public Object {
 public:
     typedef std::shared_ptr<Player> Ptr;
diff --git a/include/switch_block.hpp b/include/switch_block.hpp
index 1e7d26c..d1f8c48 100644
--- a/include/switch_block.hpp
+++ b/include/switch_block.hpp
@@ -7,6 +7,11 @@
 
 class Game;
 
+/**
+ * Le bloc changeur est un bloc spécial qui inverse la polarité
+ * des joueurs qui passent dessus. Ce bloc ne peut être utilisé
+ * qu'une seule fois par partie
+ */
 class SwitchBlock : public Block {
 public:
     typedef std::shared_ptr<SwitchBlock> Ptr;
diff --git a/include/utility.hpp b/include/utility.hpp
index 8bb4e25..01b6ea3 100644
--- a/include/utility.hpp
+++ b/include/utility.hpp
@@ -1,6 +1,9 @@
 #ifndef __SKIZZLE_UTILITY_HPP__
 #define __SKIZZLE_UTILITY_HPP__
 
+/**
+ * Fonctions utilitaires aux autres classes du jeu
+ */
 namespace Utility {
     /**
      * Permet d'animer la valeur donnée vers la valeur cible