riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #10571 from jia200x/pr/dox_conf_group

Browse Source 
doc: add configurations Doxygen group
This commit is contained in:
José Alamos 2018-12-14 14:44:01 +01:00 committed by GitHub
commit bb16a7533c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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