From 5070ed9596642ecb42f8382bd55cf6a050c583bb Mon Sep 17 00:00:00 2001
From: Jose Alamos <jose.alamos@haw-hamburg.de>
Date: Fri, 7 Dec 2018 10:11:47 +0100
Subject: [PATCH] doc: add configurations Doxygen group

---
 doc.txt | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc.txt b/doc.txt
index 0755dbfe95..e6af9d9fd7 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
-- 
GitLab