Ajout desc

PacoMouseCYD/Platformio/Arduino.old/gui.ino

@@ -1,6 +1,56 @@
+
+/**
+ * @file gui.ino
+ * @brief Graphical User Interface (GUI) for PacoMouseCYD throttle.
+ * @author F. Cañada
+ * @date 2025-2026
+ * @copyright https://usuaris.tinet.cat/fmco/
+ *
+ * This file contains functions for initializing and managing the graphical user interface,
+ * including timers, drawing routines, and event handling for the PacoMouseCYD throttle.
+ */
+
+////////////////////////////////////////////////////////////
+// API Documentation
+////////////////////////////////////////////////////////////
+/**
+ * @brief Initializes the GUI, timers, and object stacks.
+ */
+void initGUI();
+
+/**
+ * @brief Clears all system timers.
+ */
+void clearTimers();
+
+/**
+ * @brief Sets a timer with the specified parameters.
+ * @param id Timer ID.
+ * @param count Timer count value.
+ * @param type Timer type (oneshot, periodic, etc).
+ */
+void setTimer(uint16_t id, uint16_t count, uint16_t type);
+
+/**
+ * @brief Stops a timer by ID.
+ * @param id Timer ID.
+ */
+void stopTimer(uint16_t id);
+
+/**
+ * @brief Processes all timers, triggering events as needed.
+ */
+void timerProcess();
+
+// Add further function documentation here as needed for each public function.
+
+////////////////////////////////////////////////////////////
+// End API Documentation
+////////////////////////////////////////////////////////////
+
 /*    PacoMouseCYD throttle -- F. Cañada 2025-2026 --  https://usuaris.tinet.cat/fmco/
-      Very basic Graphical User Interface (GUI) for PacoMouseCYD
-      All data in absolute coordinates
+  Very basic Graphical User Interface (GUI) for PacoMouseCYD
+  All data in absolute coordinates
 */
 
 ////////////////////////////////////////////////////////////