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/BaseGameTab.hpp          | 4 ++++
 src/base_tab/BaseImportTab.hpp        | 4 ++++
 src/base_tab/BaseManageTab.hpp        | 4 ++++
 src/base_tab/BaseTab.hpp              | 4 ++++
 src/base_tab/GameListManager.hpp      | 2 +-
 src/base_tab/gamebase/GameBase.hpp    | 4 ++++
 src/base_tab/gamebase/PGNGameBase.hpp | 4 ++++
 7 files changed, 25 insertions(+), 1 deletion(-)

(limited to 'src/base_tab')

diff --git a/src/base_tab/BaseGameTab.hpp b/src/base_tab/BaseGameTab.hpp
index 2e8cf84..0abcffa 100644
--- a/src/base_tab/BaseGameTab.hpp
+++ b/src/base_tab/BaseGameTab.hpp
@@ -5,6 +5,10 @@
 #include "gamebase/PGNGameBase.hpp"
 #include "GameListManager.hpp"
 
+/**
+ * @brief A BaseTab sub-tab to list and search games
+ * 
+ */
 class BaseGameTab : public TabBase_TabGames {
   std::shared_ptr<GameBase> base;
 
diff --git a/src/base_tab/BaseImportTab.hpp b/src/base_tab/BaseImportTab.hpp
index 9a2386d..10342bd 100644
--- a/src/base_tab/BaseImportTab.hpp
+++ b/src/base_tab/BaseImportTab.hpp
@@ -6,6 +6,10 @@
 #include <vector>
 #include <utility>
 
+/**
+ * @brief A BaseTab sub-tab to import games
+ * 
+ */
 class BaseImportTab : public TabBase_TabImport {
   TabInfos *main_tab;
   std::shared_ptr<GameListManager> glm;
diff --git a/src/base_tab/BaseManageTab.hpp b/src/base_tab/BaseManageTab.hpp
index 92f80d0..4055380 100644
--- a/src/base_tab/BaseManageTab.hpp
+++ b/src/base_tab/BaseManageTab.hpp
@@ -6,6 +6,10 @@
 #include "BaseImportTab.hpp"
 #include "BaseGameTab.hpp"
 
+/**
+ * @brief A BaseTab sub-tab to manage games
+ * 
+ */
 class BaseManageTab : public TabBase_TabManage {
 
     /// Never free the following pointers in that class
diff --git a/src/base_tab/BaseTab.hpp b/src/base_tab/BaseTab.hpp
index e7e4208..bc8c603 100644
--- a/src/base_tab/BaseTab.hpp
+++ b/src/base_tab/BaseTab.hpp
@@ -13,6 +13,10 @@ wxDECLARE_EVENT(CLOSE_LINKED_TAB, wxCommandEvent);
 // Local events
 wxDECLARE_EVENT(REFRESH_MANAGE_TAB, wxCommandEvent);
 
+/**
+ * @brief Class that represents an opened chess games database in the MainWindow
+ * 
+ */
 class BaseTab : public TabBase, public TabInfos {
   /// @brief The opened database
   std::shared_ptr<GameBase> base;
diff --git a/src/base_tab/GameListManager.hpp b/src/base_tab/GameListManager.hpp
index d48ac36..5c241a2 100644
--- a/src/base_tab/GameListManager.hpp
+++ b/src/base_tab/GameListManager.hpp
@@ -25,7 +25,7 @@ typedef struct Item {
 } RType;
 
 /**
- * @brief A manager for wxListCtrl that display games
+ * @brief A helper class to manage a wxListCtrl that display games
  * 
  */
 class GameListManager {
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