Update docs (#1428)

* Clarify that MY_HOSTNAME is only supported on ESP

And remove redundant Doxygen define, that caused MY_HOSTNAME
to show up twice in the documentation.

* Fix double define of MY_RAM_ROUTING_TABLE_ENABLED

MY_RAM_ROUTING_TABLE_ENABLED showed up twice in the docs.
By reordering, the define only shows up once.

I don't think DOXYGEN will be defined when anyone builds their
sketches, so this change should not affect functionality.

* Doxygen: Add check for multiple defines of same keyword

* Fix unmatched ifdef

* Add documentation for config struct for Linux gw

This avoids the following doxygen warning:
warning: Compound config is not documented.

Author: mfalkvidd

Documentation/doxygen.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 ## Invoke from project root, e.g Documentation/doxygen.sh
+result=0
 
 # Generate doxygen file for Raspberry Pi configure command
 echo -e "/**\n * @defgroup RaspberryPiGateway Raspberry Pi Gateway\n * @ingroup MyConfigGrp\n * @brief Configuration options for the Raspberry Pi Gateway\n@{\n@verbatim" > configure.h
@@ -19,5 +20,17 @@ doxygen
 # Show any warnings created
 cat doxygen.log
 
+# Check for defines that occur multiple times
+multiple_defines=$(for file in Documentation/html/*.html; do grep -e 'memname' $file | grep 'define MY_' | cut -f2 -d'#'| cut -f1 -d'<' | awk '{ print $2 }' | sort | uniq -c | grep -v '1 MY_'; done)
+if [ -n "$multiple_defines" ]; then
+	echo "The following defines occur more than once:"
+	echo $multiple_defines
+	result=1
+else
+	echo "No defines occur more than once - great!"
+fi
+
 # Clean up autogenerated (temporary) artifacts
 rm configure.h
+
+exit $result

MyConfig.h

@@ -1423,7 +1423,7 @@
 
 /**
 * @def MY_HOSTNAME
-* @brief Hostname of your device
+* @brief Hostname of your device. Only supported on ESP8266 and ESP32.
 */
 #ifndef MY_HOSTNAME
 #define MY_HOSTNAME "MYSENSORS_DEVICE"
@@ -2352,7 +2352,6 @@
 #define MY_WIFI_SSID
 #define MY_WIFI_BSSID
 #define MY_WIFI_PASSWORD
-#define MY_HOSTNAME
 #define MY_GATEWAY_LINUX
 #define MY_GATEWAY_TINYGSM
 #define MY_GATEWAY_MQTT_CLIENT

MySensors.h

@@ -311,7 +311,15 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #endif
 
 // RAM ROUTING TABLE
-#if defined(MY_RAM_ROUTING_TABLE_FEATURE) && defined(MY_REPEATER_FEATURE)
+#ifdef DOXYGEN
+/**
+ * @def MY_RAM_ROUTING_TABLE_ENABLED
+ * @brief Automatically set if RAM routing table is enabled
+ *
+ * @see MY_RAM_ROUTING_TABLE_FEATURE
+ */
+#define MY_RAM_ROUTING_TABLE_ENABLED
+#elif defined(MY_RAM_ROUTING_TABLE_FEATURE) && defined(MY_REPEATER_FEATURE)
 // activate feature based on architecture
 #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_NRF5) || defined(ARDUINO_ARCH_STM32F1) || defined(TEENSYDUINO) || defined(__linux__)
 #define MY_RAM_ROUTING_TABLE_ENABLED
@@ -324,16 +332,7 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 // #define MY_RAM_ROUTING_TABLE_ENABLED
 #endif // __avr_atmega1280__, __avr_atmega1284__, __avr_atmega2560__
 #endif // ARDUINO_ARCH_AVR
-#endif
-#ifdef DOXYGEN
-/**
- * @def MY_RAM_ROUTING_TABLE_ENABLED
- * @brief Automatically set if RAM routing table is enabled
- *
- * @see MY_RAM_ROUTING_TABLE_FEATURE
- */
-#define MY_RAM_ROUTING_TABLE_ENABLED
-#endif
+#endif // DOXYGEN
 
 // SOFTSERIAL
 #if defined(MY_GSM_TX) != defined(MY_GSM_RX)

hal/architecture/Linux/drivers/core/config.h

@@ -24,6 +24,9 @@
 extern "C" {
 #endif
 
+/**
+* @brief Config file
+*/
 struct config {
 	int verbose;
 	int log_file;
@@ -45,4 +48,4 @@ void config_cleanup(void);
 }
 #endif
 
-#endif
+#endif