Created debug.hpp and fixed doxygen

This commit is contained in:
dario
2024-02-14 13:36:21 +01:00
parent 801408e371
commit f11a6fd5f7
4 changed files with 56 additions and 4 deletions

View File

@@ -27,6 +27,7 @@ namespace sta
/**
* @brief A status flags for the watchdog.
*
* @ingroup tacos_thread
*/
enum class ThreadStatus
{
@@ -137,13 +138,14 @@ namespace sta
protected:
/**
* @brief
* @brief Sends a heartbeat signal by setting the thread status to RUNNING
*
*/
void heartbeat();
/**
* @brief Set the thread's status to waiting. Should be called before executing
* @brief Set the thread's status to waiting. This can called before executing code which is very likely
* to exceed a watchdog cycle. This stops the watchdog from restarting the thread.
*
*/
void waiting();
@@ -151,7 +153,7 @@ namespace sta
/**
* @brief Get the current status of the thread.
*
* @return ThreadStatus
* @return ThreadStatus The current status of the thread.
*/
ThreadStatus getStatus();