add doc for HiveCore

2014-01-26 05:01:27 +01:00 · 2014-01-26 05:01:27 +01:00 · 089f700277
parent 1052364b25
commit 089f700277
2 changed files with 12 additions and 1 deletions
--- a/doc/hive.qdoc
+++ b/doc/hive.qdoc
@ -13,7 +13,7 @@
            \endlist
        \li Hive server
            \list
-                \li Hive core
+                \li \l{Hive Core}
                \li \l{JSONRPC Interface}
                \li \l{Rules}
            \endlist
--- a/server/hivecore.cpp
+++ b/server/hivecore.cpp
@ -1,3 +1,14 @@
+/*!
+    \class HiveCore
+    \brief The main entry point for the Hive Server and the place where all the messages are dispatched.
+
+    \ingroup core
+    \inmodule server
+
+    HiveCore is a singleton instance and the main entry point of the Hive daemon. It is responsible to
+    instantiate, set up and connect all the other components.
+*/
+
 #include "hivecore.h"
 #include "jsonrpcserver.h"
 #include "devicemanager.h"