Skip to content

Commit

Permalink
docs: Adds variable specifics
Browse files Browse the repository at this point in the history
  • Loading branch information
ihagad authored and ntlhui committed Nov 11, 2024
1 parent a3be6c1 commit 58ddc9a
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/chargeTask.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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;
};
Expand Down

0 comments on commit 58ddc9a

Please sign in to comment.