From 089f700277eccce45c172d069d19772045e1a17c Mon Sep 17 00:00:00 2001 From: Michael Zanetti Date: Sun, 26 Jan 2014 05:01:27 +0100 Subject: [PATCH] add doc for HiveCore --- doc/hive.qdoc | 2 +- server/hivecore.cpp | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/hive.qdoc b/doc/hive.qdoc index 84c23f3c..b7b0168f 100644 --- 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 diff --git a/server/hivecore.cpp b/server/hivecore.cpp index 08c8ceae..01917556 100644 --- 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"