Merge pull request #21 from lonkaars/master

Updating branch

1 files changed, 36 insertions, 18 deletions

diff --git a/main/config.def.h b/main/config.def.h
index e9503ed..0dae608 100644
--- a/main/config.def.h
+++ b/main/config.def.h
@@ -3,31 +3,44 @@
 #include <cyw43_country.h>
 
 /**
+ * \ingroup main
+ * \defgroup main_config config
+ * \brief Configuration options
+ * \{
+ */
+
+/**
  * \name Network (Wi-Fi) configuration
  * \{
  */
 #ifndef CFG_NET_SSID
-//! network name (SSID)
+/**
+ * \brief Network name (SSID)
+ * \note Not defining \c CFG_NET_SSID will implicitly enable \c CFG_NET_DISABLE
+ */
 #define CFG_NET_SSID ""
 #ifndef CFG_NET_DISABLE
-//! disable network communication
+/**
+ * \brief Disable network communication completely
+ * \note Enabling this option will implicitly enable \c CFG_SRV_DISABLE
+ */
 #define CFG_NET_DISABLE
 #warning No SSID defined! Disabling network communication!
 #endif
 #endif
 
 #ifndef CFG_NET_PASS
-//! network password
+//! Network password
 #define CFG_NET_PASS ""
 #endif
 
 #ifndef CFG_NET_AUTH
-//! network security type
+//! Network security type
 #define CFG_NET_AUTH CYW43_AUTH_OPEN
 #endif
 
 #ifndef CFG_NET_CONN_TIMEOUT
-//! max duration (milliseconds) for establishing wifi connection
+//! Max duration (milliseconds) for establishing Wi-Fi connection
 #define CFG_NET_CONN_TIMEOUT 10e3
 #endif
 
@@ -36,47 +49,52 @@
 #define CFG_NET_COUNTRY CYW43_COUNTRY_WORLDWIDE
 #endif
 #ifndef CFG_NET_COUNTRY
-//! radio communications country
+//! Radio communications country
 #define CFG_NET_COUNTRY CYW43_COUNTRY_NETHERLANDS
 #endif
-/** \} */
+/// \}
 
 /**
- * \name i2ctcp server configuration
+ * \name TCP server configuration
  * \{
  */
 #ifndef CFG_SRV_PORT
-//! i2ctcp server port
+//! TCP server port
 #define CFG_SRV_PORT 9191
 #endif
-
 #ifdef CFG_NET_DISABLE
-//! disable the i2ctcp server
+//! Disable the TCP server
 #define CFG_SRV_DISABLE
 #endif
-/** \} */
+/// \}
 
 /**
  * \name I2C configuration
  * \{
  */
 #ifndef CFG_SDA_PIN
-//! I^2^C SDA pin
+//! I2C SDA pin
 #define CFG_SDA_PIN 16
 #endif
 #ifndef CFG_SCL_PIN
-//! I^2^C SCL pin
+//! I2C SCL pin
 #define CFG_SCL_PIN 17
 #endif
-/** \} */
+/// \}
 
+/**
+ * \name Auxiliary options
+ * \{
+ */
 #ifndef CFG_LED_PIN
-//! status LED pin
+//! Status LED pin
 #define CFG_LED_PIN CYW43_WL_GPIO_LED_PIN
 #endif
-
 #ifndef CFG_PB_MOD_MAX
-//! maximum number of simultaniously connected puzzle modules
+//! Maximum number of simultaniously connected puzzle modules
 #define CFG_PB_MOD_MAX 8
 #endif
+/// \}
+
+/// \}