ALPAKA/sta-core
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git synced 2025-12-16 16:48:04 +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

20
include/sta/assert.hpp
View File

@@ -1,17 +1,19 @@
/**
* @brief Assertion handling.
*
* Define **STA_ASSERT_ENABLE** in `<sta/config.hpp>` to enable module.
* Configuration:
* STA_ASSERT_ENABLE: Enable module
* STA_ASSERT_DISABLE: Forces module off when defined
* STA_HALT: Override function called after failed asserts
* 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_ASSERT_DISABLE** always overrides enabling the module.
* Both `sta::assert_failed` and `sta::assert_halt` provide weak definitions and
* can be overridden by the application. `sta::assert_halt` is only called
* via the **STA_HALT** macro which can also be provided by the application.
*
* Both `assert_failed` and `assert_halt` provide weak definitions and
* can be overridden by the application. `assert_halt` is only called
* via the STA_HALT macro which can also be provided by the application.
*
* The default implementation of `assert_failed` uses **STA_DEBUG_PRINT** internally
* and will not generate any output if `<sta/debug_serial.hpp> is disabled.
* The default implementation of `sta::assert_failed` uses **STA_DEBUG_PRINT** internally
* and will not generate any output if the **DEBUG_SERIAL** module is disabled.
*/
#ifndef STA_ASSERT_HPP
#define STA_ASSERT_HPP