From e1e602e68f2458d578494a2933584536e6b6440c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20St=C3=BCrz?= <simon.stuerz@guh.io>
Date: Thu, 30 May 2019 14:17:44 +0200
Subject: [PATCH] Migrate eq-3 plugin documentation

---
 eq-3/README.md            | 29 +++++++++++++++++++++++++++
 eq-3/deviceplugineq-3.cpp | 42 ---------------------------------------
 2 files changed, 29 insertions(+), 42 deletions(-)
 create mode 100644 eq-3/README.md

diff --git a/eq-3/README.md b/eq-3/README.md
new file mode 100644
index 00000000..5cfac48e
--- /dev/null
+++ b/eq-3/README.md
@@ -0,0 +1,29 @@
+# eQ-3
+
+This plugin allows to find and control devices from Max!(eQ-3). To use this devices, you need at least
+one [Max! Cube LAN Gateway](http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-lgw-o-tw.html)
+in you local network. Once the cube is connected (DHCP), you can auto detect the cube in the network and
+add it to your [nymea](https://nymea.io) devices. Also more than one cube in the network is supported. All
+devices, which are connected to a cube, will be autogenerated. For the setup of a cube, the original
+software is recomanded (min/max setpoint temperature, weekly program...).
+
+## Supported devices
+
+### Max! Cube LAN Gateway
+
+This [cube](http://www.eq-3.de/max-heizungssteuerung-produktdetail/
+items/bc-lgw-o-tw.html) can be discovered in the network. Every device, which is connected with the cube, will be appear automatically, once the cube is configrued and
+added to nymea.
+
+### Max! Wall Thermostat
+
+In order to use this device, you need a [Max! Cube LAN Gateway](http://www.eq-3.de/max-heizungssteuerung-produktdetail/
+items/bc-lgw-o-tw.html). A [MAX! Wall Thermostat](http://www.eq-3.de/max-raumloesung-produktdetail/items/bc-tc-c-wm.html) can not be added,
+it will appear automatically in the device list, once you add it to the cube.
+
+### Max! Radiator Thermostat
+
+In order to use this device, you need a [Max! Cube LAN Gateway](http://www.eq-3.de/max-heizungssteuerung-produktdetail/
+items/bc-lgw-o-tw.html). A [MAX! Radiator Thermostat](http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-rt-trx-cyg.html) can not be added,
+it will appear automatically in the device list, once you add it to the cube.
+
diff --git a/eq-3/deviceplugineq-3.cpp b/eq-3/deviceplugineq-3.cpp
index 88ee8246..ba763170 100644
--- a/eq-3/deviceplugineq-3.cpp
+++ b/eq-3/deviceplugineq-3.cpp
@@ -20,48 +20,6 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-/*!
-    \page eq3.html
-    \title eQ-3 Max!
-    \brief Plugin for the eQ-3 heating system.
-
-    \ingroup plugins
-    \ingroup nymea-plugins
-
-    This plugin allows to find and control devices from Max!(eQ-3). To use this devices, you need at least
-    one \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-lgw-o-tw.html}{Max! Cube LAN Gateway}
-    in you local network. Once the cube is connected (DHCP), you can auto detect the cube in the network and
-    add it to your \l{https://nymea.io}{nymea} devices. Also more than one cube in the network is supported. All
-    devices, which are connected to a cube, will be autogenerated. For the setup of a cube, the original
-    software is recomanded (min/max setpoint temperature, weekly program...).
-
-    \chapter Supported devices
-        \section2 Max! Cube LAN Gateway
-            This \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/
-            items/bc-lgw-o-tw.html}{cube} can be discovered in the network. Every
-            device, which is connected with the cube, will be appear automatically, once the cube is configrued and
-            added to nymea.
-
-        \section2 Max! Wall Thermostat
-            In order to use this device, you need a \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/
-            items/bc-lgw-o-tw.html}{Max! Cube LAN Gateway}. A \l{http://www.eq-3.de/max-raumloesung-produktdetail/items/bc-tc-c-wm.html}{MAX! Wall Thermostat} can not be added,
-            it will appear automatically in the device list, once you add it to the cube.
-
-        \section2 Max! Radiator Thermostat
-            In order to use this device, you need a \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/
-            items/bc-lgw-o-tw.html}{Max! Cube LAN Gateway}. A \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-rt-trx-cyg.html}{MAX! Radiator Thermostat} can not be added,
-            it will appear automatically in the device list, once you add it to the cube.
-
-    \chapter Plugin properties
-    Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
-    and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
-
-    For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
-
-    \quotefile plugins/deviceplugins/eq-3/deviceplugineq-3.json
-*/
-
-
 #include "deviceplugineq-3.h"
 
 #include "plugin/device.h"