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/preferences/BoardPrefs.hpp  | 8 ++++++++
 src/preferences/EditorPrefs.hpp | 8 ++++++++
 2 files changed, 16 insertions(+)

(limited to 'src/preferences')

diff --git a/src/preferences/BoardPrefs.hpp b/src/preferences/BoardPrefs.hpp
index f801817..ce975f3 100644
--- a/src/preferences/BoardPrefs.hpp
+++ b/src/preferences/BoardPrefs.hpp
@@ -7,6 +7,10 @@
 #include <wx/spinctrl.h>
 #include <wx/stdpaths.h>
 
+/**
+ * @brief Configuration page for the BoardCanvas
+ * 
+ */
 class BoardPrefsPanel : public PrefsBoard {
   BoardCanvas *real_board_canvas;
   wxFileName pieces_path;
@@ -101,6 +105,10 @@ public:
   }
 };
 
+/**
+ * @brief Interface for wxWidgets to load BoardPrefsPanel into the preference window
+ * 
+ */
 class BoardPrefs : public wxPreferencesPage {
 public:
   virtual wxString GetName() const { return "Board"; }
diff --git a/src/preferences/EditorPrefs.hpp b/src/preferences/EditorPrefs.hpp
index 6958519..09abac7 100644
--- a/src/preferences/EditorPrefs.hpp
+++ b/src/preferences/EditorPrefs.hpp
@@ -6,6 +6,10 @@
 #include <wx/spinctrl.h>
 #include <wx/stdpaths.h>
 
+/**
+ * @brief Configuration page for the EditorCanvas
+ * 
+ */
 class EditorPrefsPanel : public PrefsEditor {
 
 public:
@@ -49,6 +53,10 @@ public:
   }
 };
 
+/**
+ * @brief Interface for wxWidgets to load EditorPrefsPanel into the preference window
+ * 
+ */
 class EditorPrefs : public wxPreferencesPage {
 public:
   virtual wxString GetName() const { return "Editor"; }
-- 
cgit v1.2.3