Improved some bits of documentation

include/alphabet.hpp

@@ -31,7 +31,7 @@ private:
     const std::string m_what;
 };
 
-
+//! \brief Représente un alphabet, c'est à dire un ensemble d'état et leurs propriétés.
 class Alphabet {
     //! Tableau des états
     std::vector<state> etats;

include/automaton.hpp

@@ -13,6 +13,7 @@ Cette classe représente un automate cellulaire.
 #include "transitionrule.hpp"
 #include "grid.h"
 
+//! \brief Représente une configuration d'un automate à un instant t : ses règles de voisinage et transition et son réseau.
 class Automaton {
 private:
     NeighborhoodRule* neighbourhoodRule;

include/grid.h

@@ -20,7 +20,7 @@ Cette classe représente un réseau de cellules.
 using namespace std;
 
 /**
-\struct Grid
+\class Grid
 \brief Représente une grille d'états.
 
 Cette structure représente une grille d'états.

include/interface.hpp

@@ -15,6 +15,7 @@ QT_BEGIN_NAMESPACE
 namespace Ui { class MainWindow; }
 QT_END_NAMESPACE
 
+//! \brief Fenêtre principale de l'application.
 class MainWindow : public QMainWindow
 {
     Q_OBJECT

include/modelloadingdialog.hpp

@@ -24,6 +24,7 @@ public:
     }
 };
 
+//! \brief Fenêtre de dialogue permettant de charger un modèle.
 class ModelLoadingDialog : public QDialog
 {
     Q_OBJECT

include/neighborhood.hpp

@@ -32,6 +32,7 @@ public:
     }
 };
 
+//! \brief Classe représentant un voisinage, c'est à dire une liste de cellules dont leur état et leur position.
 class Neighborhood {
 	//! \brief Vecteur de voisins contenant la position relative et l'état du voisin
     vector< pair<Coord, unsigned int> > neighborPositions;

include/neighborhood_rules/arbitraryneighborhoodrule.hpp

@@ -14,6 +14,7 @@ Représente un voisinage arbitraire, défini par l'utilisateur.
 #include "neighborhoodrule.hpp"
 #include "property.hpp"
 
+//! \brief Règle de voisinage permettant l'utilisation de voisins arbitraires.
 class ArbitraryNeighborhoodRule : public NeighborhoodRule
 {
 public:

include/neighborhood_rules/mooreNeighborhoodRule.hpp

@@ -13,6 +13,8 @@ Contient la classe de la règle de Moore (semblable à VonNeumann avec les diago
 #include "neighborhoodrule.hpp"
 #include "neighborhood.hpp"
 
+
+//! \brief Voisinage de Moore.
 class mooreNeighborhoodRule : public NeighborhoodRule
 {
     NeighborhoodFormat format;

include/neighborhood_rules/vonNeumannNeighborhoodRule.hpp

@@ -14,6 +14,7 @@ Contient la classe de la règle de Von Neumann.
 #include "neighborhoodrule.hpp"
 #include "neighborhood.hpp"
 
+//! \brief Voisinage de Von Neumann.
 class vonNeumannNeighborhoodRule : public NeighborhoodRule
 {
     NeighborhoodFormat format;

include/property.hpp

@@ -83,7 +83,7 @@ private:
 
 /**
 \class PropertyImpl
-
+\brief Classe utilitaire pour les accepteur de PropertyVisitor.
 Classe utilitaire permettant de définir automatiquement 'accept' parmi les classes implémentant un type de Property.
  */
 template <typename Child>
@@ -103,7 +103,7 @@ public:
 
 /**
 \class HasUserProperties
-
+\brief Représente une classe possédant des Property.
 Permet à une classe héritant de HasUSerProperties d'avoir des objets Property fonctionnels.
  **/
 class HasUserProperties
@@ -131,7 +131,7 @@ private:
 /**
 \class StringProperty
 
-Représente une propriété textuelle.
+\brief Représente une propriété textuelle.
 **/
 struct StringProperty : public PropertyImpl<StringProperty>
 {
@@ -152,7 +152,7 @@ public:
 /**
 \class IntegerProperty
 
-Représente une propriété entière bornée.
+\brief Représente une propriété entière bornée.
 **/
 struct IntegerProperty : public PropertyImpl<IntegerProperty>
 {
@@ -170,7 +170,7 @@ public:
 /**
 \class CoordinateProperty
 
-Représente une coordonnée relative 2D.
+\brief Représente une coordonnée relative 2D.
 **/
 struct CoordinateProperty : public PropertyImpl<CoordinateProperty>
 {
@@ -185,7 +185,7 @@ public:
 /**
 \class PropertyList
 
-Représente une liste de propriétés.
+\brief Représente une liste de propriétés.
 
 \todo Documenter l'ensemble des fonctions membres.
 **/

include/propertyvisitors.hpp

@@ -34,7 +34,7 @@ public:
 /**
 \class UIBuilderVisitor
 
-Cette classe permet de remplir un widget fourni en argument avec une représentation interactive de Property.
+\brief Cette classe permet de remplir un widget fourni en argument avec une représentation interactive de Property.
 **/
 
 
@@ -66,7 +66,7 @@ private:
 /**
 \class PropertySaverVisitor
 
-Cette classe permet de sauvegarder un ensemble de Property dans un object JSON donné.
+\brief Cette classe permet de sauvegarder un ensemble de Property dans un object JSON donné.
 **/
 class PropertySaverVisitor : public PropertyVisitor
 {
@@ -95,7 +95,7 @@ private:
 /**
 \class PropertyLoaderVisitor
 
-Cette classe permet de charger un ensemble de Property depuis un pbject JSON donné.
+\brief Cette classe permet de charger un ensemble de Property depuis un pbject JSON donné.
 **/
 class PropertyLoaderVisitor : public PropertyVisitor
 {

include/savingdialog.hpp

@@ -7,6 +7,7 @@ namespace Ui {
 class SavingDialog;
 }
 
+//! \brief Fenêtre de dialogue permettant d'obtenir des informations d'enregistrement comme l'auteur, un titre ou une date.
 class SavingDialog : public QDialog
 {
     Q_OBJECT
@@ -15,9 +16,13 @@ public:
     explicit SavingDialog(QWidget *parent = nullptr);
     ~SavingDialog();
 
+    //! \brief Retourne l'auteur choisi.
     QString auteur() const;
+    //! \brief Retourne le titre choisi.
     QString titre() const;
+    //! \brief Retourne la description choisie.
     QString desc() const;
+    //! \brief Retourne la date choisie.
     QDate date() const;
 
 protected:

include/state.hpp

@@ -15,24 +15,25 @@ Représente les données graphiques associées à un état d'un alphabet.
 
 #include "stateColor.hpp"
 
+//! \brief Représente les données cosmétiques associées à un état.
 class state{
-    //! Couleur de l'état --> C'est un objet stateColor dont les attributs sont rouge, vert, bleu
+    //! \brief Couleur de l'état --> C'est un objet stateColor dont les attributs sont rouge, vert, bleu
     stateColor color;
-    //! Nom de l'état
+    //! \brief Nom de l'état
     std::string label;
 
 public:
-    //! Constructeur de l'état
+    //! \brief Constructeur de l'état
     state(stateColor c, const std::string& l = "sans nom"):color(c),label(l){}
 
-    //! Accesseur en lecture de la couleur
+    //! \brief Accesseur en lecture de la couleur
     stateColor getColor() const { return color; }
-    //! Accesseur en lecture du label
+    //! \brief Accesseur en lecture du label
     std::string getStateLabel() const { return label; }
 
-    //! Accesseur en écriture de la couleur
+    //! \brief Accesseur en écriture de la couleur
     void setColor(stateColor c){ color=c; }
-    //! Accesseur en écriture du label
+    //! \brief Accesseur en écriture du label
     void setStateLabel(const std::string& l){ label=l; }
 };
 

include/stateColor.hpp

@@ -12,6 +12,7 @@ Représente la couleur associée à un état.
 #ifndef STATECOLOR_H
 #define STATECOLOR_H
 
+//! \brief Représente la couleur d'un état.
 class stateColor{ // Chaque objet stateColor (couleur) est décrit par trois attributs (RGB)
     unsigned char redColor;
     unsigned char greenColor;

include/structurereader.hpp

@@ -32,7 +32,7 @@ private:
 };
 
 //! \class StructureReader
-//! Classe abstraite permettant de lire une Structure à partir de différents formats de fichier.
+//! \brief Classe abstraite permettant de lire une Structure à partir de différents formats de fichier.
 class StructureReader
 {
 public:

include/structurewriter.hpp

@@ -18,7 +18,7 @@ Fichier contenant la classe StructureWrite et ses filles, permettant de sauvegar
 #include "structure.hpp"
 
 //! \class StructureWrite
-//! Classe abstraite permettant de sauvegarder une Structure sous différents formats de fichier.
+//! \brief Classe abstraite permettant de sauvegarder une Structure sous différents formats de fichier.
 class StructureWriter
 {
 public:
@@ -30,7 +30,7 @@ public:
 };
 
 //! \class RLEStructureWrite
-//! Sauvegarde une structure au format Extended RLE de Golly (https://www.conwaylife.com/wiki/Run_Length_Encoded)
+//! \brief Sauvegarde une structure au format Extended RLE de Golly (https://www.conwaylife.com/wiki/Run_Length_Encoded)
 class RLEStructureWriter : public StructureWriter
 {
 public:
@@ -47,7 +47,7 @@ private:
 };
 
 //! \class JSONStructureWrite
-//! Sauvegarde une structure au format JSON
+//! \brief Sauvegarde une structure au format JSON
 class JSONStructureWriter : public StructureWriter
 {
 public:

include/transition_rules/circulartransition.hpp

@@ -3,7 +3,8 @@
 
 #include "transitionrule.hpp"
 
-// http://joatdev.fr/CyclicAutomaton
+//! \brief Transition circulaire.
+//! cf. http://joatdev.fr/CyclicAutomaton
 class CircularTransition : public TransitionRule
 {
 public:

include/transition_rules/lifegametransition.h

@@ -3,6 +3,7 @@
 
 #include "transitionrule.hpp"
 
+//! \brief Transition correspondant au jeu de la vie de Conway.
 class LifeGameTransition : public TransitionRule
 {
 public:

include/transition_rules/totalistictransition.hpp

@@ -33,7 +33,7 @@ private:
     std::string m_what;
 };
 
-//! Représente un intervalle [low;high] composé d'expressions mathématiques
+//! \brief Représente un intervalle [low;high] composé d'expressions mathématiques
 struct Interval
 {
     std::string low, high;

include/transitionrule.hpp

@@ -17,6 +17,7 @@ Cette classe représente une règle de transition.
 
 struct NeighborhoodFormat;
 
+//! \brief Représente une règle de transition.
 class TransitionRule : public HasUserProperties {
 private: