Verified Commit 8c818140 authored by Romain De Laage De Bellefaye's avatar Romain De Laage De Bellefaye 🌳
Browse files

Improve doc for Database and Coordonnees

parent 73f2df04
Pipeline #79814 passed with stage
in 15 seconds
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
#include <voisinage.h> #include <voisinage.h>
#include <Automate.h> #include <Automate.h>
/// Cette classe adapte un objet base de données pour le rendre facile d'utilisation dans le cadre de l'application /// @brief Cette classe adapte un objet base de données pour le rendre facile d'utilisation dans le cadre de l'application
/// ///
/// Il suffit de lui donner le nom du fichier sqlite à la création et d'appeler les méthodes pour intéragir avec. Les pointeurs retournés par les méthodes getFonction, getRegleVoisinage et getReseau pointent vers des objets dynamiques dont la charge de la destruction est laissée à l'utilisateur /// Il suffit de lui donner le nom du fichier sqlite à la création et d'appeler les méthodes pour intéragir avec. Les pointeurs retournés par les méthodes getFonction, getRegleVoisinage et getReseau pointent vers des objets dynamiques dont la charge de la destruction est laissée à l'utilisateur
class Database { class Database {
......
#ifndef COORDONNEES_H #ifndef COORDONNEES_H
#define COORDONNEES_H #define COORDONNEES_H
/// Structure de Coordonnees permettant de décrire les coordonnées d'une cellule /// @brief Structure de Coordonnees permettant de décrire les coordonnées d'une cellule
/// ///
/// etant donné que notre grille est en 2D, on a donc deux coordonnées x et y /// etant donné que notre grille est en 2D, on a donc deux coordonnées x et y
/// peu d'intérêt de définir une classe pour qq chose de si simple, une structure fait l'affaire /// peu d'intérêt de définir une classe pour qq chose de si simple, une structure fait l'affaire
/// les opérateurs ==, !=, + et - ont été redéfinis pour cette classe
struct Coordonnees struct Coordonnees
{ {
/// Abscisse de la Coordonnees /// Abscisse de la Coordonnees
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment