From 5155c301964672339b135efca1d764a4ae8f8ab7 Mon Sep 17 00:00:00 2001
From: dario <dario.vandenboom@arcor.de>
Date: Wed, 26 Jun 2024 17:11:02 +0200
Subject: [PATCH] Added docstring to STA_DEBUG_READ

---
 include/sta/debug/debug.hpp | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/include/sta/debug/debug.hpp b/include/sta/debug/debug.hpp
index 9cc3654..dec9b4c 100644
--- a/include/sta/debug/debug.hpp
+++ b/include/sta/debug/debug.hpp
@@ -15,16 +15,16 @@ namespace sta
 /**
  * @brief Debug print message.
  *
- * @param ... See @ref sta::PrintableUART::print
+ * @param ... See @ref sta::Printable::print
  *
  * @ingroup sta_core_debug
  */
 #  	define STA_DEBUG_PRINT(...)      		sta::Debug->print(__VA_ARGS__)
 
 /**
- * @brief Debug print message followed by new-line to UART.
+ * @brief Debug print message followed by new-line to the printable.
  *
- * @param ... See @ref sta::PrintableUART::println
+ * @param ... See @ref sta::Printable::println
  *
  * @ingroup sta_core_debug
  */
@@ -33,11 +33,19 @@ namespace sta
 /**
  * @brief Formatted debug printing with new-line.
  *
- * @param fmt See @ref sta::PrintableUART::printf
- * @param ... See @ref sta::PrintableUART::printf
+ * @param fmt See @ref sta::Printable::printf
+ * @param ... See @ref sta::Printable::printf
  */
 #  	define STA_DEBUG_PRINTF(fmt, ...)		sta::Debug->printf(fmt, __VA_ARGS__)
 
+/**
+ * @brief Read string via printable.
+ * 
+ * @param ... See @ref sta::Printable::read
+ * 
+ * @ingroup sta_core_debug
+ * 
+ */
 #	define STA_DEBUG_READ(buffer, length)	sta::Debug->read(buffer, length)
 
 #else // !STA_DEBUGGING_ENABLED