Documented Boot Behavior enumeration and its members

src/sleepTask.hpp

@@ -15,14 +15,38 @@ class SleepTask : public Task {
     STATES_e run(void);
     void exit(void);
 
+    /**
+     * @brief Defines possible boot behaviors
+     */
     typedef enum BOOT_BEHAVIOR_
     {
+        /**
+         * @brief Standard boot behavior
+         */
         BOOT_BEHAVIOR_NORMAL=0,
+        /**
+         * @brief Initiate temporary calibration on startup
+         */
         BOOT_BEHAVIOR_TMP_CAL_START=1,
+        /**
+         * @brief Continue temporary calibration sequence
+         */
         BOOT_BEHAVIOR_TMP_CAL_CONTINUE=2,
+        /**
+         * @brief End temporary calibration
+         */
         BOOT_BEHAVIOR_TMP_CAL_END=3,
+        /**
+         * @brief Reattempts data upload
+         */
         BOOT_BEHAVIOR_UPLOAD_REATTEMPT=4,
+        /**
+         * @brief Boot behavior is not specified
+         */
         BOOT_BEHAVIOR_NOT_SET=255
+    /**
+     * @brief Type definition for Boot Behavior enum
+     */
     } BOOT_BEHAVIOR_e;
 
     /**
@@ -36,18 +60,28 @@ class SleepTask : public Task {
     static const char* strBootBehavior(BOOT_BEHAVIOR_e behavior);
     /**
      * @brief Updates boot behavior to NVRAM
-    */
+     * 
+     * @param BOOT_BEHAVIOR_e Boot Behavior to set
+     */
     static void setBootBehavior(BOOT_BEHAVIOR_e);
     /**
      * @brief Get's current boot behavior from NVRAM
-    */
+     * 
+     * @return Current Boot Behavior
+     */
     static BOOT_BEHAVIOR_e getBootBehavior(void);
     /**
      * @brief Load boot behavior onto board
-    */
+     */
     static void loadBootBehavior(void);
     private:
+    /**
+     * @brief Stores current Boot Behavior
+     */
     static BOOT_BEHAVIOR_e bootBehavior;
+    /**
+     * @brief Manages LED status display settings
+     */
     LEDStatus ledStatus;
 };
 #endif