ALPAKA/sta-core
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git synced 2025-06-10 16:55:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added docstring to STA_DEBUG_READ

Browse Source
This commit is contained in:
dario 2024-06-26 17:11:02 +02:00
parent d4f03a9249
commit 5155c30196
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
include/sta/debug/debug.hpp
View File

@ -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