From ed0f25ec9df7157acad8e20d6c084a8465acba08 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20St=C3=BCrz?= <stuerz.simon@gmail.com>
Date: Wed, 5 Aug 2015 02:08:31 +0200
Subject: [PATCH] improve documentation

---
 doc/allclasses.qdoc        |  1 +
 doc/api.qdoc               |  9 +++++++++
 doc/guh.qdoc               | 34 ++++++++++++++++++++++------------
 doc/guhcore.qdoc           |  2 +-
 doc/jsonrpc.qdoc           |  2 +-
 doc/libguh.qdoc            |  2 +-
 doc/rest.qdoc              |  9 +++++++++
 server/websocketserver.cpp |  2 ++
 8 files changed, 46 insertions(+), 15 deletions(-)
 create mode 100644 doc/api.qdoc
 create mode 100644 doc/rest.qdoc

diff --git a/doc/allclasses.qdoc b/doc/allclasses.qdoc
index 194d6c0b..ceb4861c 100644
--- a/doc/allclasses.qdoc
+++ b/doc/allclasses.qdoc
@@ -3,4 +3,5 @@
     \title All guh Classes
 
     \generatelist classes
+    \generatelist overviews
 */
diff --git a/doc/api.qdoc b/doc/api.qdoc
new file mode 100644
index 00000000..fdf2d9e2
--- /dev/null
+++ b/doc/api.qdoc
@@ -0,0 +1,9 @@
+/*!
+    \page api.html
+    \title The guh API's
+    
+    \l{JSON-RPC API}
+    
+    \l{REST API}
+    
+*/
diff --git a/doc/guh.qdoc b/doc/guh.qdoc
index f1256df4..4fa5aa3d 100644
--- a/doc/guh.qdoc
+++ b/doc/guh.qdoc
@@ -2,31 +2,41 @@
     \page index.html
     \title guh - Developer Documentation
 
-    \section1 Summary
+    \section1 Overview
     The guh backend service consists of three main modules:
 
     \list
-        \li \l{libguh}
+        \li \l{guhserver}{The guh server}
+            \list
+                \li \l{guhserver}{The guh server namespace}
+                \li \l{Rules}
+            \endlist
+        \li \l{libguh}{The guh library}
             \list
                 \li \l{Types}{Types used in the guh system}
                 \li \l{Device Plugins}{The Device Plugin API}
-                \li \l{Hardware Resources}{Hardware Resources}
+                \li \l{Hardware Resources}{Hardware resources available for plugins}
             \endlist
-        \li \l{guhserver}
-            \list
-                \li \l{guh Core}
-                \li \l{JSONRPC Interface}
-                \li \l{Rules}
-            \endlist
-        \li \l{Plugins}.
+        \li \l{Plugins}{The guh plugins}
             \list
                 \li \l{RF 433 MHz Plugins}
                 \li \l{Service Plugins}
                 \li \l{Network Plugins}
-            \endlist
+            \endlist        
     \endlist
 
-    \section2 Quicklinks
+    \section1 API's
+    \list
+        \li \l{JSON-RPC API}
+        \li \l{https://github.com/guh/guh/wiki/REST-Api-documentation}{REST API}
+    \endlist
+
+    \section1 How To's
+    \list
+        \li How to write a plugin
+    \endlist
+
+    \section1 Quicklinks
     \list
         \li \l{All guh Classes}        
         \li \l{All Modules}
diff --git a/doc/guhcore.qdoc b/doc/guhcore.qdoc
index 46343155..a1f12fd4 100644
--- a/doc/guhcore.qdoc
+++ b/doc/guhcore.qdoc
@@ -2,6 +2,6 @@
     \page guhcore-index.html
     \title guh Core
 
-    \annotatedlist core
+    \annotatedlist server
 */
 
diff --git a/doc/jsonrpc.qdoc b/doc/jsonrpc.qdoc
index 10e6480b..36eb09d2 100644
--- a/doc/jsonrpc.qdoc
+++ b/doc/jsonrpc.qdoc
@@ -1,6 +1,6 @@
 /*!
     \page jsonrpc.html
-    \title JSONRPC Interface
+    \title JSON-RPC API
     \ingroup jsonrpc
 
     \brief The JSON RPC interface represents a TCP socket connection using plaintext string communication.
diff --git a/doc/libguh.qdoc b/doc/libguh.qdoc
index 154958a3..019b6831 100644
--- a/doc/libguh.qdoc
+++ b/doc/libguh.qdoc
@@ -1,6 +1,6 @@
 /*!
     \module libguh
-    \title libguh
+    \title The guh library
 
     \section1 Types
     \annotatedlist types
diff --git a/doc/rest.qdoc b/doc/rest.qdoc
new file mode 100644
index 00000000..e340d136
--- /dev/null
+++ b/doc/rest.qdoc
@@ -0,0 +1,9 @@
+/*!
+    \page rest.html
+    \title REST API
+
+    \brief The REST API description of the guh server.
+
+    
+
+*/
diff --git a/server/websocketserver.cpp b/server/websocketserver.cpp
index e1286637..93ac47da 100644
--- a/server/websocketserver.cpp
+++ b/server/websocketserver.cpp
@@ -25,6 +25,8 @@
     \ingroup core
     \inmodule server
 
+    \note The WebSocketServer is only available for builds with Qt version greater than Qt 5.3.0!
+
     The websocket server provides a server for websocket clients based on
     \l{http://tools.ietf.org/html/rfc6455}{Protocol Version 13}. The default
     port for the websocket server is 4444, which is according to this