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/game_tab/right_panel/LiveEngineDialog.hpp | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/game_tab/right_panel/LiveEngineDialog.hpp')

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;
-- 
cgit v1.2.3