From dcb5cc9928f2f90377574201061c4befd869194d Mon Sep 17 00:00:00 2001
From: Patrick Fallberg <patrick@fallberg.net>
Date: Tue, 19 Jan 2016 20:46:18 +0100
Subject: [PATCH] Cleaned up Doxygen include graphs

---
 libraries/MySensors/MySensor.h                | 46 ++++++++++++++++---
 libraries/MySensors/core/MyGatewayTransport.h |  3 --
 libraries/MySensors/core/MyHwATMega328.h      |  2 -
 libraries/MySensors/core/MyHwESP8266.h        |  4 --
 libraries/MySensors/core/MyHwSAMD.h           |  3 --
 libraries/MySensors/core/MyProtocol.h         |  3 +-
 libraries/MySensors/core/MySigning.h          |  5 +-
 7 files changed, 42 insertions(+), 24 deletions(-)

diff --git a/libraries/MySensors/MySensor.h b/libraries/MySensors/MySensor.h
index 75ef82d..90ef395 100644
--- a/libraries/MySensors/MySensor.h
+++ b/libraries/MySensors/MySensor.h
@@ -1,4 +1,4 @@
-/**
+/*
  * The MySensors Arduino library handles the wireless radio link and protocol
  * between your home built sensors/actuators and HA controller of choice.
  * The sensors forms a self healing radio network with optional repeaters. Each
@@ -16,13 +16,30 @@
  * modify it under the terms of the GNU General Public License
  * version 2 as published by the Free Software Foundation.
  */
+
+/**
+ * @file MySensor.h
+ *
+ * MySensors main interface (includes all necessary code for the library)
+ */
 #ifndef MySensor_h
 #define MySensor_h
 
-#include "MyConfig.h"
 #include "core/MySensorCore.h"
 
 // Detect node type
+/**
+ * @def MY_GATEWAY_FEATURE
+ * @brief Is set for gateway sketches.
+ */
+/**
+ * @def MY_IS_GATEWAY
+ * @brief Is true when @ref MY_GATEWAY_FEATURE is set.
+ */
+/**
+ * @def MY_NODE_TYPE
+ * @brief Contain a string describing the class of sketch/node (gateway/repeater/sensor).
+ */
 #if defined(MY_GATEWAY_SERIAL) || defined(MY_GATEWAY_W5100) || defined(MY_GATEWAY_ENC28J60) || defined(ARDUINO_ARCH_ESP8266) || defined(MY_GATEWAY_MQTT_CLIENT)
 	#define MY_GATEWAY_FEATURE
 	#define MY_IS_GATEWAY (true)
@@ -82,11 +99,17 @@
 #endif
 
 
-// default LEDs blinking period in milliseconds
+/**
+ * @def MY_DEFAULT_LED_BLINK_PERIOD
+ * @brief Default LEDs blinking period in milliseconds.
+ */
 #ifndef MY_DEFAULT_LED_BLINK_PERIOD
 #define MY_DEFAULT_LED_BLINK_PERIOD 300
 #endif
-// The RX LED default pin
+/**
+ * @def MY_DEFAULT_RX_LED_PIN
+ * @brief The RX LED default pin.
+ */
 #ifndef MY_DEFAULT_RX_LED_PIN
 	#if defined(ARDUINO_ARCH_ESP8266)
 		#define MY_DEFAULT_RX_LED_PIN 8
@@ -94,7 +117,10 @@
 		#define MY_DEFAULT_RX_LED_PIN 6
 	#endif
 #endif
-// The TX LED default pin
+/**
+ * @def MY_DEFAULT_TX_LED_PIN
+ * @brief The TX LED default pin.
+ */
 #ifndef MY_DEFAULT_TX_LED_PIN
 	#if defined(ARDUINO_ARCH_ESP8266)
 		#define MY_DEFAULT_TX_LED_PIN 9
@@ -102,7 +128,10 @@
 		#define MY_DEFAULT_TX_LED_PIN 5
 	#endif
 #endif
-// The Error LED default pin
+/**
+ * @def MY_DEFAULT_ERR_LED_PIN
+ * @brief The Error LED default pin.
+ */
 #ifndef MY_DEFAULT_ERR_LED_PIN
 	#if defined(ARDUINO_ARCH_ESP8266)
 		#define MY_DEFAULT_ERR_LED_PIN 7
@@ -275,3 +304,8 @@
 #endif
 
 #endif
+// Doxygen specific constructs, not included when built normally
+// This is used to enable disabled macros/definitions to be included in the documentation as well.
+#if DOXYGEN
+#define MY_GATEWAY_FEATURE
+#endif
diff --git a/libraries/MySensors/core/MyGatewayTransport.h b/libraries/MySensors/core/MyGatewayTransport.h
index e971bd1..d34bd31 100644
--- a/libraries/MySensors/core/MyGatewayTransport.h
+++ b/libraries/MySensors/core/MyGatewayTransport.h
@@ -20,10 +20,7 @@
 #ifndef MyGatewayTransport_h
 #define MyGatewayTransport_h
 
-#include "MyConfig.h"
-#include "MyMessage.h"
 #include "MyProtocol.h"
-#include "MySensorCore.h"
 
 // Common gateway functions
 
diff --git a/libraries/MySensors/core/MyHwATMega328.h b/libraries/MySensors/core/MyHwATMega328.h
index 5f01c2d..9b9a487 100644
--- a/libraries/MySensors/core/MyHwATMega328.h
+++ b/libraries/MySensors/core/MyHwATMega328.h
@@ -21,8 +21,6 @@
 #define MyHwATMega328_h
 
 #include "MyHw.h"
-#include "MyConfig.h"
-#include "MyMessage.h"
 #include <avr/eeprom.h>
 #include <avr/pgmspace.h>
 #include <avr/sleep.h>
diff --git a/libraries/MySensors/core/MyHwESP8266.h b/libraries/MySensors/core/MyHwESP8266.h
index b3a5bf0..bd958cb 100644
--- a/libraries/MySensors/core/MyHwESP8266.h
+++ b/libraries/MySensors/core/MyHwESP8266.h
@@ -20,10 +20,6 @@
 #define MyHwESP8266_h
 
 #include "MyHw.h"
-#include "MyConfig.h"
-
-#include "MyMessage.h"
-
 
 #ifdef __cplusplus
 #include <Arduino.h>
diff --git a/libraries/MySensors/core/MyHwSAMD.h b/libraries/MySensors/core/MyHwSAMD.h
index dc5f468..fcc5a9d 100644
--- a/libraries/MySensors/core/MyHwSAMD.h
+++ b/libraries/MySensors/core/MyHwSAMD.h
@@ -20,9 +20,6 @@
 #define MyHwSAMD_h
 
 #include "MyHw.h"
-#include "MyConfig.h"
-
-#include "MyMessage.h"
 #include <Wire.h>
 
 #ifdef __cplusplus
diff --git a/libraries/MySensors/core/MyProtocol.h b/libraries/MySensors/core/MyProtocol.h
index 324759a..766abfc 100644
--- a/libraries/MySensors/core/MyProtocol.h
+++ b/libraries/MySensors/core/MyProtocol.h
@@ -20,8 +20,7 @@
 #ifndef MyProtocol_h
 #define MyProtocol_h
 
-#include "MyConfig.h"
-#include "MyMessage.h"
+#include "MySensorCore.h"
 
 
 // parse(message, inputString)
diff --git a/libraries/MySensors/core/MySigning.h b/libraries/MySensors/core/MySigning.h
index 68d76a8..8677151 100644
--- a/libraries/MySensors/core/MySigning.h
+++ b/libraries/MySensors/core/MySigning.h
@@ -473,11 +473,8 @@
 #ifndef MySigning_h
 #define MySigning_h
 
-#include "MyConfig.h"
-#include <stdint.h>
-#include "MyMessage.h"
-#include "drivers/ATSHA204/ATSHA204.h"
 #include "MySensorCore.h"
+#include "drivers/ATSHA204/ATSHA204.h"
 
 #ifdef MY_SIGNING_NODE_WHITELISTING
 typedef struct {