Skip to content

Commit

Permalink
Resolved docstring issues and added parameter name to setBootBehavior
Browse files Browse the repository at this point in the history
  • Loading branch information
amanpalanati committed Nov 9, 2024
1 parent a967822 commit ad25cd1
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions src/sleepTask.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ class SleepTask : public Task {
*/
BOOT_BEHAVIOR_NORMAL=0,
/**
* @brief Initiate temporary calibration on startup
* @brief Initiate temperature calibration on startup
*/
BOOT_BEHAVIOR_TMP_CAL_START=1,
/**
* @brief Continue temporary calibration sequence
* @brief Continue temperature calibration sequence
*/
BOOT_BEHAVIOR_TMP_CAL_CONTINUE=2,
/**
* @brief End temporary calibration
* @brief End temperature calibration
*/
BOOT_BEHAVIOR_TMP_CAL_END=3,
/**
Expand All @@ -44,9 +44,6 @@ class SleepTask : public Task {
* @brief Boot behavior is not specified
*/
BOOT_BEHAVIOR_NOT_SET=255
/**
* @brief Type definition for Boot Behavior enum
*/
} BOOT_BEHAVIOR_e;

/**
Expand All @@ -61,9 +58,9 @@ class SleepTask : public Task {
/**
* @brief Updates boot behavior to NVRAM
*
* @param BOOT_BEHAVIOR_e Boot Behavior to set
* @param behavior Boot Behavior to set
*/
static void setBootBehavior(BOOT_BEHAVIOR_e);
static void setBootBehavior(BOOT_BEHAVIOR_e behavior);
/**
* @brief Get's current boot behavior from NVRAM
*
Expand Down

0 comments on commit ad25cd1

Please sign in to comment.