From e329ead0f8714726498c6259b4dc742194b9755b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20St=C3=BCrz?= <stuerz.simon@gmail.com>
Date: Sat, 1 Feb 2014 21:34:11 +0100
Subject: [PATCH] added plugin documentation for intertechno devices

---
 doc/hive.qdoc                                 |  2 +-
 doc/plugins.qdoc                              |  8 +++++++
 libhive/gpio.cpp                              |  6 ++---
 libhive/radio433.cpp                          | 10 ++++-----
 .../intertechno/devicepluginintertechno.cpp   | 22 +++++++++++++++++++
 .../intertechno/devicepluginintertechno.h     |  1 +
 6 files changed, 38 insertions(+), 11 deletions(-)
 create mode 100644 doc/plugins.qdoc

diff --git a/doc/hive.qdoc b/doc/hive.qdoc
index 8134ec94..aaf7e27d 100644
--- a/doc/hive.qdoc
+++ b/doc/hive.qdoc
@@ -17,7 +17,7 @@
                 \li \l{JSONRPC Interface}
                 \li \l{Rules}
             \endlist
-        \li Device plugins. A collection of officially supported device plugins.
+        \li \l{Plugins}. A collection of officially supported device plugins.
     \endlist
 
     \section2 Quicklinks
diff --git a/doc/plugins.qdoc b/doc/plugins.qdoc
new file mode 100644
index 00000000..d6d6d46d
--- /dev/null
+++ b/doc/plugins.qdoc
@@ -0,0 +1,8 @@
+/*!
+    \page plugins.html
+    \title Plugins
+
+    \annotatedlist plugins
+*/
+
+
diff --git a/libhive/gpio.cpp b/libhive/gpio.cpp
index f03841dc..f8bf5c01 100644
--- a/libhive/gpio.cpp
+++ b/libhive/gpio.cpp
@@ -20,16 +20,14 @@
 #include "gpio.h"
 #include <QDebug>
 
-/*! Constructs a \l{Gpio} object to represent a GPIO with the given \a gpio number and the \a parent.
- */
+/*! Constructs a \l{Gpio} object to represent a GPIO with the given \a gpio number and the \a parent. */
 Gpio::Gpio(QObject *parent, int gpio) :
     QThread(parent),m_gpio(gpio)
 {
     exportGpio();
 }
 
-/*! Destroys the Gpio object and unexports the GPIO.
- */
+/*! Destroys the Gpio object and unexports the GPIO. */
 Gpio::~Gpio()
 {
     unexportGpio();
diff --git a/libhive/radio433.cpp b/libhive/radio433.cpp
index bf337b70..d78f6f31 100644
--- a/libhive/radio433.cpp
+++ b/libhive/radio433.cpp
@@ -31,8 +31,8 @@ Radio433::Radio433(QObject *parent) :
 
     m_receiver->start();
 }
-/*! Destroyes the \l{Radio433} object and stops the running threads.
- */
+
+/*! Destroyes the \l{Radio433} object and stops the running threads. */
 Radio433::~Radio433()
 {
     m_receiver->quit();
@@ -66,8 +66,7 @@ void Radio433::sendData(QList<int> rawData)
 
 }
 
-/*! Returns the current system time in microseconds.
- */
+/*! Returns the current system time in microseconds. */
 int Radio433::micros()
 {
     struct timeval tv ;
@@ -79,8 +78,7 @@ int Radio433::micros()
     return (int)(now - m_epochMicro) ;
 }
 
-/*! Creates a delay of a certain time (\a microSeconds).
- */
+/*! Creates a delay of a certain time (\a microSeconds). */
 void Radio433::delayMicros(int microSeconds)
 {
     struct timespec sleeper;
diff --git a/plugins/deviceplugins/intertechno/devicepluginintertechno.cpp b/plugins/deviceplugins/intertechno/devicepluginintertechno.cpp
index c979ec0a..7d1a80c9 100644
--- a/plugins/deviceplugins/intertechno/devicepluginintertechno.cpp
+++ b/plugins/deviceplugins/intertechno/devicepluginintertechno.cpp
@@ -1,3 +1,25 @@
+/*!
+    \page intertechno.html
+    \title Intertechno
+
+    \ingroup plugins
+
+    This plugin supports al Intertechno RF 433 MHz devices from following list:
+
+    \table
+    \header
+        \li Model
+        \li Device Type
+    \row
+        \li 0
+        \li LOW
+    \row
+        \li 1
+        \li HIGH
+    \endtable
+
+  */
+
 #include "devicepluginintertechno.h"
 
 #include "device.h"
diff --git a/plugins/deviceplugins/intertechno/devicepluginintertechno.h b/plugins/deviceplugins/intertechno/devicepluginintertechno.h
index 55962352..399d2e69 100644
--- a/plugins/deviceplugins/intertechno/devicepluginintertechno.h
+++ b/plugins/deviceplugins/intertechno/devicepluginintertechno.h
@@ -1,6 +1,7 @@
 #ifndef DEVICEPLUGININTERTECHNO_H
 #define DEVICEPLUGININTERTECHNO_H
 
+
 #include "deviceplugin.h"
 
 class DevicePluginIntertechno : public DevicePlugin