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

Rework doxygen comments

Browse Source
This commit is contained in:
Henrik Stickann 2022-04-12 16:43:40 +02:00
parent 30b9c04460
commit c1d468bb32
3 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/sta/assert.hpp
View File

@ -1,16 +1,16 @@
/** /**
* @brief Assertion handling. * @brief Assertion handling.
* *
* Define `STA_ASSERT_ENABLE` in `<sta/config.hpp>` to enable. * Define **STA_ASSERT_ENABLE** in `<sta/config.hpp>` to enable module.
* *
* Defining `DEBUG` will automatically enable the module. * When **DEBUG** is defined the module will be enabled automatically.
* Defining `NDEBUG` will always force module to be disabled. * Defining **NDEBUG** or **STA_ASSERT_DISABLE** always overrides enabling the module.
* *
* Both `assert_failed` and `assert_halt` provide weak definitions and * Both `assert_failed` and `assert_halt` provide weak definitions and
* can be overridden by the application. `assert_halt` is only called * can be overridden by the application. `assert_halt` is only called
* via the STA_HALT macro which can also be provided by the application. * via the STA_HALT macro which can also be provided by the application.
* *
* The default implementation of `assert_failed` uses `STA_DEBUG_PRINT` internally * The default implementation of `assert_failed` uses **STA_DEBUG_PRINT** internally
* and will not generate any output if `<sta/debug_serial.hpp> is disabled. * and will not generate any output if `<sta/debug_serial.hpp> is disabled.
*/ */
#ifndef STA_ASSERT_HPP #ifndef STA_ASSERT_HPP
@ -24,17 +24,16 @@
# endif // !STA_ASSERT_ENABLE # endif // !STA_ASSERT_ENABLE
#endif // DEBUG #endif // DEBUG
#ifdef NDEBUG #if defined(NDEBUG) || defined(STA_ASSERT_DISABLE)
# ifdef STA_ASSERT_ENABLE # ifdef STA_ASSERT_ENABLE
# undef STA_ASSERT_ENABLE # undef STA_ASSERT_ENABLE
# endif // STA_ASSERT_ENABLE # endif // STA_ASSERT_ENABLE
#endif // NDEBUG #endif // NDEBUG || STA_ASSERT_DISABLE
#ifdef STA_ASSERT_ENABLE #ifdef STA_ASSERT_ENABLE
#include <cstdint> #include <cstdint>
#include <assert.h>
namespace sta namespace sta

12
include/sta/debug_serial.hpp
View File

@ -1,12 +1,12 @@
/** /**
* @brief Debug output via UART. * @brief Debug output via UART.
* *
* Define `STA_DEBUG_SERIAL_ENABLE` in `<sta/config.hpp>` to enable. * Define **STA_DEBUG_SERIAL_ENABLE** in `<sta/config.hpp>` to enable module.
* *
* Defining `DEBUG` will automatically enable the module. * When **DEBUG** is defined the module will be enabled automatically.
* Defining `NDEBUG` will always force module to be disabled. * Defining **NDEBUG** or **STA_DEBUG_SERIAL_DISABLE** always overrides enabling the module.
* *
* Application must provide the sta::DebugSerial instance. * The sta::DebugSerial instance must be provided.
* NOTE: Include this header before the definition because * NOTE: Include this header before the definition because
* the default internal linkage of const namespace variables * the default internal linkage of const namespace variables
* will cause undefined reference errors otherwise. * will cause undefined reference errors otherwise.
@ -22,11 +22,11 @@
# endif // !STA_DEBUG_SERIAL_ENABLE # endif // !STA_DEBUG_SERIAL_ENABLE
#endif // DEBUG #endif // DEBUG
#ifdef NDEBUG #if defined(NDEBUG) || defined(STA_DEBUG_SERIAL_DISABLE)
# ifdef STA_DEBUG_SERIAL_ENABLE # ifdef STA_DEBUG_SERIAL_ENABLE
# undef STA_DEBUG_SERIAL_ENABLE # undef STA_DEBUG_SERIAL_ENABLE
# endif // STA_DEBUG_SERIAL_ENABLE # endif // STA_DEBUG_SERIAL_ENABLE
#endif // NDEBUG #endif // NDEBUG || STA_DEBUG_SERIAL_DISABLE
#ifdef STA_DEBUG_SERIAL_ENABLE #ifdef STA_DEBUG_SERIAL_ENABLE

3
include/sta/lang.hpp
View File

@ -1,3 +1,6 @@
/**
* @brief Helper for useful compiler features.
*/
#ifndef STA_LANG_HPP #ifndef STA_LANG_HPP
#define STA_LANG_HPP #define STA_LANG_HPP