From 1d77846e9e7bbbb91e9a89af379910d4b246ba21 Mon Sep 17 00:00:00 2001
From: "@CarlWachter" <carlwachter@web.de>
Date: Sat, 1 Jun 2024 12:02:10 +0200
Subject: [PATCH] Timer Documentation extended for timer types

---
 include/sta/rtos/timer.hpp | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/include/sta/rtos/timer.hpp b/include/sta/rtos/timer.hpp
index c0b1525..644d6fe 100644
--- a/include/sta/rtos/timer.hpp
+++ b/include/sta/rtos/timer.hpp
@@ -26,10 +26,13 @@ namespace sta
 	{
 	public:
 		/**
-		 * @brief
+		 * @brief Creates a new timer with a given callback function.
 		 *
 		 * @param callback 	The callback function to call upon timer timeout.
 		 * @param arg 		The argument to pass to the callback function.
+		 * @param type 		The type of timer to create. The Options are:
+		 * 					- osTimerOnce: One-shot timer.
+		 * 					- osTimerPeriodic: Repeating timer.
 		 */
 		RtosTimer(std::function<void(void*)>, void *arg, osTimerType_t type = osTimerOnce);