Skip to content

Commit

Permalink
doc: enable helper macros for doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
miri64 committed Mar 3, 2015
1 parent 83c61cb commit 21dd2eb
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
9 changes: 8 additions & 1 deletion core/include/debug.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
11 changes: 11 additions & 0 deletions doc.txt
Original file line number Diff line number Diff line change
@@ -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.
*/
5 changes: 4 additions & 1 deletion doc/doxygen/riot.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 21dd2eb

Please sign in to comment.