Ajout desc

PacoMouseCYD/Platformio/Arduino.old/file.ino

@@ -1,3 +1,39 @@
+
+/**
+ * @file file.ino
+ * @brief File handling and storage for PacoMouseCYD throttle.
+ * @author F. Cañada
+ * @date 2025-2026
+ * @copyright https://usuaris.tinet.cat/fmco/
+ *
+ * This file contains functions for managing locomotive data files, checking file names,
+ * saving and loading data to and from the SD card or internal filesystem, and related utilities.
+ */
+
+////////////////////////////////////////////////////////////
+// API Documentation
+////////////////////////////////////////////////////////////
+/**
+ * @brief Checks if a file name has a .csv extension.
+ * @param fileName The file name to check.
+ * @return True if the file name ends with .csv, false otherwise.
+ */
+bool checkName(char *fileName);
+
+/**
+ * @brief Saves locomotive data to a .csv file.
+ * @param fs The filesystem object.
+ * @param pos The position in the locomotive data array.
+ * @return True if the data was saved successfully, false otherwise.
+ */
+bool saveLocoData(fs::FS &fs, uint16_t pos);
+
+// 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/
 */