doc: add configurations Doxygen group

This commit is contained in:
Jose Alamos 2018-12-07 10:11:47 +01:00
parent 050e06f20f
commit 5070ed9596

17
doc.txt
View File

@ -1,3 +1,20 @@
/**
* @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