Merge branch 'main' into 95-docs-sleep-task

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.3.2](https://github.com/UCSD-E4E/smartfin-fw3/compare/v3.3.1...v3.3.2) (2024-11-12)
+
+
+### Bug Fixes
+
+* fields inside menu_ documented. revert unintended changes ([fd3ef27](https://github.com/UCSD-E4E/smartfin-fw3/commit/fd3ef27c16882a7c122ad6b22777aba013098a8a))
+
 ## [3.3.1](https://github.com/UCSD-E4E/smartfin-fw3/compare/v3.3.0...v3.3.1) (2024-11-07)
 
 

src/chargeTask.hpp

@@ -26,13 +26,32 @@ class ChargeTask : public Task{
     void init(void);
     /**
      * @brief Charges the device, and exits to CLI on command
-    */
+     * 
+     * @return STATE_CLI when CLI pattern entered or
+     * STATE_DEEP_SLEEP when device not charging
+     */
     STATES_e run(void);
     void exit(void);
 
     private:
+    /**
+     * @brief Buffer for storing command-line input
+     * 
+     * Character array holds input from CLI with a maxiumum size of 'CLI_BUFFER_LEN'
+    */
     char inputBuffer[CLI_BUFFER_LEN];
+    /**
+     * @brief LED status indicator for charging task
+     *
+     * Object defines visual status of device's charging state
+     */
     LEDStatus ledStatus;
+    /**
+     * @brief Timestamp for tracking start of charging process
+     * 
+     * startTime = 0 indicates the device charging since
+     * the powering on of the device
+     */
     system_tick_t startTime;
 };
 #endif

src/fileCLI/fileCLI.hpp

@@ -93,9 +93,21 @@ class FileCLI{
     DIR* dir_stack[FILE_CLI_MAX_DIR_DEPTH];
     char path_stack[FILE_CLI_MAX_DIR_DEPTH][NAME_MAX];
     int current_dir;
+
+    /**
+     * @brief Structure representing a command menu entry for FileCLI.
+     *
+     */
     typedef struct menu_
     {
+        /**
+         * A character representing a user command. Will trigger a specific function.
+         */
         const char cmd;
+        /**
+         * A pointer to a place in flash memory or RAM where a function with properties is held.
+         * Executes the command associated with cmd.
+         */
         void (FileCLI::*fn)(void);
     } menu_t;
     static menu_t fsExplorerMenu[];

src/vers.hpp

@@ -12,7 +12,7 @@
 
 #define FW_MAJOR_VERSION    3
 #define FW_MINOR_VERSION    3
-#define FW_BUILD_NUM        1
+#define FW_BUILD_NUM        2
 #define FW_BRANCH           ""
 
 #if PRODUCT_VERSION_USE_HEX == 1