Cleanup doxygen

This commit is contained in:
Henrik Stickann
2023-01-31 21:14:02 +01:00
parent a7466d6417
commit 4204c028a2
24 changed files with 89 additions and 154 deletions

View File

@@ -3,10 +3,10 @@
* @brief Debug output via UART.
*
* Configuration:
* STA_DEBUG_SERIAL_UART: UART interface for output
* STA_DEBUG_SERIAL_FORCE: Ignore debug defines and always enable output
* DEBUG: Enables output when defined
* NDEBUG: Disables output when defined (overrides DEBUG)
* * STA_DEBUG_SERIAL_UART: UART interface for output
* * STA_DEBUG_SERIAL_FORCE: Ignore debug defines and always enable output
* * DEBUG: Enables output when defined
* * NDEBUG: Disables output when defined (overrides DEBUG)
*/
#ifndef STA_CORE_DEBUG_SERIAL_HPP
#define STA_CORE_DEBUG_SERIAL_HPP
@@ -17,28 +17,6 @@
* @brief Debug serial output.
*/
#ifdef DOXYGEN
/**
* @def STA_DEBUG_SERIAL_UART
* @brief UART interface for debug output.
*
* @ingroup staCoreBuildConfig
*/
# define STA_DEBUG_SERIAL_UART
/**
* @def STA_DEBUG_SERIAL_FORCE
* @brief Force enable module.
*
* Enables debug output even if NDEBUG is defined
* or DEBUG is not defined.
*
* @ingroup staCoreBuildConfig
*/
# define STA_DEBUG_SERIAL_FORCE
#endif // DOXYGEN
#include <sta/config.hpp>
// Determine if module should be enabled
@@ -57,14 +35,7 @@
# endif // !STA_DEBUG_SERIAL_FORCE
#endif // STA_DEBUG_SERIAL_UART
// Show enabled module in doxygen output
#ifdef DOXYGEN
# define STA_DEBUG_SERIAL_ENABLED
#endif // DOXYGEN
#ifdef STA_DEBUG_SERIAL_ENABLED
#if defined(STA_DEBUG_SERIAL_ENABLED) || defined(DOXYGEN)
#include <sta/printable_uart.hpp>