Skip to content
Snippets Groups Projects
Commit 5070ed95 authored by Jose Alamos's avatar Jose Alamos
Browse files

doc: add configurations Doxygen group

parent 050e06f2
No related branches found
No related tags found
No related merge requests found
/**
* @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 * @defgroup utils Utilities
* @brief Utilities and helper functionality * @brief Utilities and helper functionality
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment