diff --git a/core/include/debug.h b/core/include/debug.h index e4f32c830f..9b91cb3856 100644 --- a/core/include/debug.h +++ b/core/include/debug.h @@ -26,9 +26,16 @@ #include "sched.h" #ifdef __cplusplus - extern "C" { +extern "C" { #endif +/** + * @def ENABLE_DEBUG + * @brief This macro can be defined as 0 or other on a file-based level. + * If ENABLE_DEBUG is 0 @ref DEBUG() and @ref DEBUGF() will generate + * no output if not they will generate output. + */ + /** * @name Print debug information if the calling thread stack is large enough * diff --git a/doc.txt b/doc.txt new file mode 100644 index 0000000000..8867c08710 --- /dev/null +++ b/doc.txt @@ -0,0 +1,11 @@ +/** + * @def DEVELHELP + * @brief This global macro activates some behavior that helps you while + * developing but is otherwise optimized out. + */ + +/** + * @def TEST_SUITES + * @brief This global macro activates functionality that is needed for + * automated testing but not needed otherwise. + */ diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index f0da64d3dd..c825054888 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -1990,7 +1990,10 @@ PREDEFINED = __attribute__(x)= \ RTT_NUMOF \ GPIO_NUMOF \ SPI_NUMOF \ - UART_NUMOF + UART_NUMOF \ + DEVELHELP \ + ENABLE_DEBUG \ + TEST_SUITES # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this