mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
51 lines
1.3 KiB
Plaintext
51 lines
1.3 KiB
Plaintext
/**
|
|
* @defgroup config Compile time configurations
|
|
* @brief List of compile-time configurations
|
|
*
|
|
* This group contains all compile-time configurations macros that are
|
|
* intended to be modified by the user.
|
|
*
|
|
* These configuration macros are defined within modules like this:
|
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [.c]
|
|
* #ifndef SOME_CONFIGURATION_PARAM
|
|
* #define SOME_CONFIGURATION_PARAM DEFAULT_VALUE
|
|
* #endif
|
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
* Because of that, configurations can be altered e.g via CFLAGS (e.g
|
|
* `CFLAGS += -DSOME_CONFIGURATION_PARAM=SOME_VALUE`)
|
|
*/
|
|
|
|
/**
|
|
* @defgroup utils Utilities
|
|
* @brief Utilities and helper functionality
|
|
*
|
|
* Additional scripts and configuration options to ease RIOT
|
|
* development.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @def DEVELHELP
|
|
* @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
|
|
#endif
|
|
|
|
/**
|
|
* @def TEST_SUITES
|
|
* @brief This global macro activates functionality that is needed for
|
|
* automated testing but not needed otherwise.
|
|
*/
|
|
#if DOXYGEN
|
|
# define TEST_SUITES
|
|
#endif
|
|
|
|
/**
|
|
* @}
|
|
*/
|