From 617f2b01b2679ec43330ea6fb5f25f4137565b6a Mon Sep 17 00:00:00 2001
From: Loic Guegan <manzerbredes@mailbox.org>
Date: Sat, 13 May 2023 10:43:21 +0200
Subject: Improve documentation

---
 src/base_tab/gamebase/GameBase.hpp    | 4 ++++
 src/base_tab/gamebase/PGNGameBase.hpp | 4 ++++
 2 files changed, 8 insertions(+)

(limited to 'src/base_tab/gamebase')

diff --git a/src/base_tab/gamebase/GameBase.hpp b/src/base_tab/gamebase/GameBase.hpp
index 1ef5f59..b2c1488 100644
--- a/src/base_tab/gamebase/GameBase.hpp
+++ b/src/base_tab/gamebase/GameBase.hpp
@@ -3,6 +3,10 @@
 #include <algorithm>
 #include <vector>
 
+/**
+ * @brief Represent the interface that each database type (such as PGNGameBase) must follow
+ * to be accessible in OChess.
+ */
 class GameBase {
 
 public:
diff --git a/src/base_tab/gamebase/PGNGameBase.hpp b/src/base_tab/gamebase/PGNGameBase.hpp
index f455ebd..c37e551 100644
--- a/src/base_tab/gamebase/PGNGameBase.hpp
+++ b/src/base_tab/gamebase/PGNGameBase.hpp
@@ -3,6 +3,10 @@
 #include "GameBase.hpp"
 #include "pgnp.hpp"
 
+/**
+ * @brief Used to open PGN files
+ * 
+ */
 class PGNGameBase : public GameBase {
   pgnp::PGN *pgn;
   bool hasNextGame;
-- 
cgit v1.2.3