diff --git a/doc.txt b/doc.txt index 0755dbfe95928946304b24c82bc14a266315fde9..e6af9d9fd7e192a392c702c62591b701ceb7bc07 100644 --- a/doc.txt +++ b/doc.txt @@ -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