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

Improve README and doxygen comments

Browse Source
This commit is contained in:
Henrik Stickann
2022-04-24 13:42:34 +02:00
parent 020870016c
commit ecfad2e768
8 changed files with 141 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
include/sta/debug_serial.hpp
View File

@@ -1,12 +1,13 @@
/**
* @brief Debug output via UART.
*
* Define **STA_DEBUG_SERIAL_ENABLE** in `<sta/config.hpp>` to enable module.
* Configuration:
* STA_DEBUG_SERIAL_ENABLE: Enable module
* STA_DEBUG_SERIAL_DISABLE: Forces module off when defined
* DEBUG: Automatically enables module when defined
* NDEBUG: Forces module off when defined
*
* When **DEBUG** is defined the module will be enabled automatically.
* Defining **NDEBUG** or **STA_DEBUG_SERIAL_DISABLE** always overrides enabling the module.
*
* The sta::DebugSerial instance must be provided.
* The `sta::DebugSerial` instance must be provided.
* NOTE: Include this header before the definition because
* the default internal linkage of const namespace variables
* will cause undefined reference errors otherwise.