From f754a93f9f13fa7f30386caba397b91e127aab2c Mon Sep 17 00:00:00 2001
From: Loic Guegan <manzerbredes@mailbox.org>
Date: Fri, 13 Jan 2023 10:42:57 +0100
Subject: Debug MainWindow and add comments

---
 src/game_tab/Game.hpp | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/game_tab/Game.hpp')

diff --git a/src/game_tab/Game.hpp b/src/game_tab/Game.hpp
index ddf5cf6..6f9bbb7 100644
--- a/src/game_tab/Game.hpp
+++ b/src/game_tab/Game.hpp
@@ -5,13 +5,19 @@
 #include "ochess.hpp"
 #include <unordered_map>
 
+/**
+ * @brief Hold an entire chess game
+ * Used in many places in the projects.
+ */
 class Game {
+  /// @brief 64 char string that contains all the pieces on the board (used in BoardCanvas)
   std::string board;
   std::string initial_fen;
   std::string result;
   std::unordered_map<std::string, std::string> tags;
   HalfMove *moves;
   HalfMove *current;
+  /// @brief Used by various methods of the class
   chessarbiter::ChessArbiter arbiter;
 
 public:
@@ -29,12 +35,15 @@ public:
   HalfMove *GetMoves();
   std::string GetFen();
   std::string GetResult();
+  /// @brief Play the given absolute move
   bool Play(std::string move,char promotion='q');
   bool IsBlackToPlay();
   bool IsCheckmate(bool forBlack);
+  /// @brief Check if a given absolute move consists in a pawn promotion
   bool IsPromotionMove(std::string absolute_move);
   void Previous();
   void Next();
+  /// @brief Delete a move (its mainline and variations recursively)
   void DeleteMove(HalfMove *m);
   void PromoteMove(HalfMove *m);
   void SetMoveAsMainline(HalfMove *m);
-- 
cgit v1.2.3