Merge pull request #2429 from authmillenon/all/doc/enable-helper-macros

doc: enable helper macros for doxygen

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
  *

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.
+ */

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