Amélioration de la documentation des classes

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;

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;

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;

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;

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;

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;

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;

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