From 3447aa31d687161387b5c8e324aecdd1d324b2df Mon Sep 17 00:00:00 2001 From: Iha Date: Thu, 17 Oct 2024 15:52:56 -0700 Subject: [PATCH 1/5] Commiting test --- src/chargeTask.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp index 11cf1da8..d91fcc5a 100644 --- a/src/chargeTask.hpp +++ b/src/chargeTask.hpp @@ -21,7 +21,7 @@ class ChargeTask : public Task{ */ void init(void); /** - * @brief Charges the device, and exits to CLI on command + * @brief Charges the device, and exits to CLI on command. */ STATES_e run(void); void exit(void); From a666b89b31b7cf1cb6fb7eb40fbe0712963706ce Mon Sep 17 00:00:00 2001 From: Iha Date: Thu, 17 Oct 2024 15:57:18 -0700 Subject: [PATCH 2/5] docs: Charge Task Fixes #89 --- src/chargeTask.hpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp index d91fcc5a..a00db0c0 100644 --- a/src/chargeTask.hpp +++ b/src/chargeTask.hpp @@ -21,8 +21,8 @@ class ChargeTask : public Task{ */ void init(void); /** - * @brief Charges the device, and exits to CLI on command. - */ + * @brief Charges the device, and exits to CLI on command.. + */ STATES_e run(void); void exit(void); From a3be6c1639ad8b0d3022cd796bf22c3fce399268 Mon Sep 17 00:00:00 2001 From: Iha Date: Thu, 17 Oct 2024 17:15:56 -0700 Subject: [PATCH 3/5] docs: Add variable and function documentation --- src/chargeTask.hpp | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp index a00db0c0..d8d5c510 100644 --- a/src/chargeTask.hpp +++ b/src/chargeTask.hpp @@ -21,14 +21,29 @@ class ChargeTask : public Task{ */ void init(void); /** - * @brief Charges the device, and exits to CLI on command.. + * @brief Charges the device, and exits to CLI on command + * + * @return Current status of charge task */ 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 provides visual status of device's charging state + */ LEDStatus ledStatus; + /** + * @brief Timestamp for tracking start of charging process + */ system_tick_t startTime; }; #endif From 58ddc9a535a09d1c37c4213d2655cb02195363cd Mon Sep 17 00:00:00 2001 From: Iha Date: Mon, 21 Oct 2024 13:37:00 -0700 Subject: [PATCH 4/5] docs: Adds variable specifics --- src/chargeTask.hpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp index d8d5c510..f28553ea 100644 --- a/src/chargeTask.hpp +++ b/src/chargeTask.hpp @@ -23,7 +23,7 @@ class ChargeTask : public Task{ /** * @brief Charges the device, and exits to CLI on command * - * @return Current status of charge task + * @return State of device: STATE_CLI or STATE_DEEP_SLEEP */ STATES_e run(void); void exit(void); @@ -38,11 +38,13 @@ class ChargeTask : public Task{ /** * @brief LED status indicator for charging task * - * Object provides visual status of device's charging state + * 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 for 0 milliseconds */ system_tick_t startTime; }; From d84d407187f41494d152eb871623da7a2e2e48bc Mon Sep 17 00:00:00 2001 From: Iha Date: Fri, 8 Nov 2024 09:41:40 -0800 Subject: [PATCH 5/5] docs: function and variable doc changed --- src/chargeTask.hpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/chargeTask.hpp b/src/chargeTask.hpp index f28553ea..b67bd5ca 100644 --- a/src/chargeTask.hpp +++ b/src/chargeTask.hpp @@ -23,7 +23,8 @@ class ChargeTask : public Task{ /** * @brief Charges the device, and exits to CLI on command * - * @return State of device: STATE_CLI or STATE_DEEP_SLEEP + * @return STATE_CLI when CLI pattern entered or + * STATE_DEEP_SLEEP when device not charging */ STATES_e run(void); void exit(void); @@ -44,7 +45,8 @@ class ChargeTask : public Task{ /** * @brief Timestamp for tracking start of charging process * - * startTime = 0 indicates the device charging for 0 milliseconds + * startTime = 0 indicates the device charging since + * the powering on of the device */ system_tick_t startTime; };