Improve documentation

3 files changed, 13 insertions, 0 deletions

diff --git a/src/game_tab/right_panel/GameTabRightPanel.hpp b/src/game_tab/right_panel/GameTabRightPanel.hpp
index 73b058a..8e4cc68 100644
--- a/src/game_tab/right_panel/GameTabRightPanel.hpp
+++ b/src/game_tab/right_panel/GameTabRightPanel.hpp
@@ -12,6 +12,10 @@ wxDECLARE_EVENT(GAME_CHANGE, wxCommandEvent);
 wxDECLARE_EVENT(SHOW_ENGINE_EVALUATION, wxCommandEvent);
 wxDECLARE_EVENT(LIVE_ANALYSIS_STATUS, wxCommandEvent);
 
+/**
+ * @brief Right panel of the GameTab and contains the EditorCanvas and the live engine tab
+ * 
+ */
 class GameTabRightPanel : public TabGameRightPanel {
   std::shared_ptr<Game> game;
   EditorCanvas *editor_canvas;
diff --git a/src/game_tab/right_panel/LiveEngineDialog.hpp b/src/game_tab/right_panel/LiveEngineDialog.hpp
index a74a2d6..8975ed2 100644
--- a/src/game_tab/right_panel/LiveEngineDialog.hpp
+++ b/src/game_tab/right_panel/LiveEngineDialog.hpp
@@ -7,11 +7,16 @@
 
 wxDECLARE_EVENT(SHOW_ENGINE_EVALUATION, wxCommandEvent);
 
+/// @brief Contains the current engine evaluation (sorted vector of best lines + position score in cp)
 typedef struct EngineEvaluation {
   std::vector<std::string> best_lines;
   float eval=0;
 } EngineEvaluation;
 
+/**
+ * @brief Dialog to control the current running engine on the game tab
+ * 
+ */
 class LiveEngineDialog : public DialogLiveEngine {
   uciadapter::UCI *engine;
   std::string engine_name;
diff --git a/src/game_tab/right_panel/editor/EditorCanvas.hpp b/src/game_tab/right_panel/editor/EditorCanvas.hpp
index 7fea474..bf3a0ee 100644
--- a/src/game_tab/right_panel/editor/EditorCanvas.hpp
+++ b/src/game_tab/right_panel/editor/EditorCanvas.hpp
@@ -9,6 +9,10 @@
 // Foreign events
 wxDECLARE_EVENT(GAME_CHANGE, wxCommandEvent);
 
+/**
+ * @brief Contains the moves editor for the currently opened game
+ * 
+ */
 class EditorCanvas : public wxPanel, public cgeditor::CGEditor {
   wxPaintDC *dc;
   wxPoint Middle(cgeditor::Element e);