1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

doc: describe usage of DEVELHELP

This commit is contained in:
smlng 2017-11-20 16:05:24 +01:00
parent a7bc9afc4b
commit a05032f293

View File

@ -9,8 +9,11 @@
/**
* @def DEVELHELP
* @brief This global macro activates some behavior that helps you while
* developing but is otherwise optimized out.
* @brief This global macro activates functionality to help developers.
*
* Additional code parts such as (extensive) debug output and sanity
* checks using assertions. To activate it set environment variable
* `DEVELHELP=1`, or disable explicitly with `DEVELHELP=0`.
*/
#if DOXYGEN
# define DEVELHELP