diff --git a/doc/allmodules.qdoc b/doc/allmodules.qdoc index c6ac2395..f1138a13 100644 --- a/doc/allmodules.qdoc +++ b/doc/allmodules.qdoc @@ -4,7 +4,8 @@ \table 80% \row \li \l{libguh} \li Common data types and plugin interfaces - \row \li \l{guh server} \li The guh server daemon implementation + \row \li \l{guhserver} \li The guh server daemon implementation + \row \li \l{Plugins} \li The device plugins of the guh server \endtable */ diff --git a/doc/guh.qdoc b/doc/guh.qdoc index cba2df40..f1256df4 100644 --- a/doc/guh.qdoc +++ b/doc/guh.qdoc @@ -12,7 +12,7 @@ \li \l{Device Plugins}{The Device Plugin API} \li \l{Hardware Resources}{Hardware Resources} \endlist - \li \l{guh server} + \li \l{guhserver} \list \li \l{guh Core} \li \l{JSONRPC Interface} diff --git a/doc/guhserver.qdoc b/doc/guhserver.qdoc index ae8eba78..41c90a8b 100644 --- a/doc/guhserver.qdoc +++ b/doc/guhserver.qdoc @@ -1,17 +1,7 @@ /*! - \module server - \title guh server - The guh server is the instance that communicates with the hardware and provides a JSONRPC interface - for communicating with the UI. It consists of those parts: - - \section3 guh core - \annotatedlist core - - \section3 JSRONRPC Interface - \annotatedlist jsonrpc - - \section3 Rules Engine - \annotatedlist rules + \namespace guhserver + \brief The namespace for the server. + \inmodule server */ diff --git a/doc/rules.qdoc b/doc/rules.qdoc index db5ebc33..ed4cbc0e 100644 --- a/doc/rules.qdoc +++ b/doc/rules.qdoc @@ -10,13 +10,13 @@ A rule is composed by a set of \l{Event}{Events}, \l{State}{States} and \l{Action}{Actions}. This diagram shows how rules are composed and interpreted by - the \l{RuleEngine}. + the \l{guhserver::RuleEngine}. \image Rules_definition.svg "Rules definition" - A basic concept of a \l{Rule} is the trigger path. This is the path that defines when a \l{Rule} + A basic concept of a \l{guhserver::Rule} is the trigger path. This is the path that defines when a \l{guhserver::Rule} is triggered for evaluation. Each element added on a trigger path (either red or blue) has the possibility to trigger the - \l{RuleEngine} to evaluate the complete rule and ultimately execute the defined \l{Action}{Actions} if the + \l{guhserver::RuleEngine} to evaluate the complete rule and ultimately execute the defined \l{Action}{Actions} if the whole rule evaluates to true. Once the trigger path has been left (i.e. a black arrow is followed), subsequent elements will still be evaluated when the rule is triggered, but they won't trigger the evaluation themselves. diff --git a/libguh/devicemanager.cpp b/libguh/devicemanager.cpp index 2f62f2d9..125aed50 100644 --- a/libguh/devicemanager.cpp +++ b/libguh/devicemanager.cpp @@ -163,8 +163,8 @@ /*! \fn void DeviceManager::eventTriggered(const Event &event) The DeviceManager will emit a \l{Event} described in \a event whenever a Device - creates one. Normally only \l{GuhCore} should connect to this and execute actions - after checking back with the \{RulesEngine}. Exceptions might be monitoring interfaces + creates one. Normally only \l{guhserver::GuhCore} should connect to this and execute actions + after checking back with the \{guhserver::RulesEngine}. Exceptions might be monitoring interfaces or similar, but you should never directly react to this in a \l{DevicePlugin}. */ @@ -187,8 +187,8 @@ #include #include -/*! Constructs the DeviceManager with the given \a parent. There should only be one DeviceManager in the system created by \l{GuhCore}. - * Use \c GuhCore::instance()->deviceManager() instead to access the DeviceManager. */ +/*! Constructs the DeviceManager with the given \a parent. There should only be one DeviceManager in the system created by \l{guhserver::GuhCore}. + * Use \c guhserver::GuhCore::instance()->deviceManager() instead to access the DeviceManager. */ DeviceManager::DeviceManager(QObject *parent) : QObject(parent), m_radio433(0) @@ -224,6 +224,7 @@ DeviceManager::~DeviceManager() } } +/*! Returns the list of search direcorys where \l{DevicePlugin} will be searched. */ QStringList DeviceManager::pluginSearchDirs() { QStringList searchDirs; @@ -234,6 +235,7 @@ QStringList DeviceManager::pluginSearchDirs() return searchDirs; } +/*! Returns the list of json objects containing the metadata of the installed plugins. */ QList DeviceManager::pluginsMetadata() { QList pluginList; diff --git a/libguh/plugin/devicedescriptor.cpp b/libguh/plugin/devicedescriptor.cpp index 2450a77e..7d510ef1 100644 --- a/libguh/plugin/devicedescriptor.cpp +++ b/libguh/plugin/devicedescriptor.cpp @@ -26,7 +26,7 @@ \ingroup devices \inmodule libguh - An DeviceDescriptor describes an \l{Device} in order to match it with a \l{Rule}. + An DeviceDescriptor describes an \l{Device} in order to match it with a \l{guhserver::Rule}. \sa Device */ diff --git a/libguh/types/eventdescriptor.cpp b/libguh/types/eventdescriptor.cpp index cbdcf2c5..d0f34108 100644 --- a/libguh/types/eventdescriptor.cpp +++ b/libguh/types/eventdescriptor.cpp @@ -26,9 +26,9 @@ \ingroup types \inmodule libguh - An EventDescriptor describes an \l{Event} in order to match it with a \l{Rule}. + An EventDescriptor describes an \l{Event} in order to match it with a \l{guhserver::Rule}. - \sa Event, EventType, Rule + \sa Event, EventType, guhserver::Rule */ #include "eventdescriptor.h" diff --git a/libguh/types/paramdescriptor.cpp b/libguh/types/paramdescriptor.cpp index c6ae2c89..320b3121 100644 --- a/libguh/types/paramdescriptor.cpp +++ b/libguh/types/paramdescriptor.cpp @@ -26,7 +26,7 @@ \ingroup types \inmodule libguh - An ParamDescriptor describes a \l{Param} in order to match it with a \l{Rule}. + An ParamDescriptor describes a \l{Param} in order to match it with a \l{guhserver::yRule}. \sa Param, ParamType */ diff --git a/libguh/types/ruleaction.cpp b/libguh/types/ruleaction.cpp index b7e74a97..2e031e48 100644 --- a/libguh/types/ruleaction.cpp +++ b/libguh/types/ruleaction.cpp @@ -21,15 +21,15 @@ /*! \class RuleAction - \brief Describes an action for a \l{Rule}. + \brief Describes an action for a \l{guhserver::Rule}. \ingroup types \inmodule libguh - A RuleAction describes a special form of an \l{Action} for a \l{Rule}. The main difference is - the \l{RuleActionParam}, which allows to use an EventTypeId within a \l{Rule} to execute this \l{RuleAction}. + A RuleAction describes a special form of an \l{Action} for a \l{guhserver::Rule}. The main difference is + the \l{RuleActionParam}, which allows to use an EventTypeId within a \l{guhserver::Rule} to execute this \l{RuleAction}. - \sa Rule, RuleActionParam, + \sa guhserver::Rule, RuleActionParam, */ #include "ruleaction.h" diff --git a/libguh/types/ruleactionparam.cpp b/libguh/types/ruleactionparam.cpp index 9a99eecd..633357ed 100644 --- a/libguh/types/ruleactionparam.cpp +++ b/libguh/types/ruleactionparam.cpp @@ -29,7 +29,7 @@ A RuleActionParam allows rules to take over an \l{Event} parameter into a rule \l{RuleAction}. - \sa Rule, RuleAction, + \sa guhserver::Rule, RuleAction, */ #include "ruleactionparam.h" diff --git a/libguh/types/statedescriptor.cpp b/libguh/types/statedescriptor.cpp index 618d8771..62631c8a 100644 --- a/libguh/types/statedescriptor.cpp +++ b/libguh/types/statedescriptor.cpp @@ -26,9 +26,9 @@ \ingroup types \inmodule libguh - An StateDescriptor describes a \l{State} in order to match it with a \l{Rule}. + An StateDescriptor describes a \l{State} in order to match it with a \l{guhserver::Rule}. - \sa State, Rule + \sa State, guhserver::Rule */ diff --git a/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp b/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp index 17a96b5b..770e4453 100644 --- a/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp +++ b/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp @@ -28,12 +28,12 @@ This plugin allows to receive UDP packages over a certain UDP port and generates an \l{Event} if the message content matches the \l{Param} command. - \note This plugin is ment to be combined with a \l{Rule}. + \note This plugin is ment to be combined with a \l{guhserver::Rule}. \section3 Example If you create an UDP Commander on port 2323 and with the command \c{"Light 1 ON"}, following command will trigger an \l{Event} in guh - and allows you to connect this \l{Event} with a \l{Rule}. + and allows you to connect this \l{Event} with a \l{guhserver::Rule}. \note In this example guh is running on \c localhost diff --git a/server/guhcore.cpp b/server/guhcore.cpp index 701b43ab..4ca6b1c5 100644 --- a/server/guhcore.cpp +++ b/server/guhcore.cpp @@ -20,7 +20,7 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /*! - \class GuhCore + \class guhserver::GuhCore \brief The main entry point for the Guh Server and the place where all the messages are dispatched. \ingroup core @@ -30,69 +30,69 @@ instantiate, set up and connect all the other components. */ -/*! \enum GuhCore::RunningMode +/*! \enum guhserver::GuhCore::RunningMode \value RunningModeApplication Guh runns as application. \value RunningModeService Guh is started as service (daemon). */ -/*! \fn void GuhCore::eventTriggered(const Event &event); +/*! \fn void guhserver::GuhCore::eventTriggered(const Event &event); This signal is emitted when an \a event happend. */ -/*! \fn void GuhCore::deviceStateChanged(Device *device, const QUuid &stateTypeId, const QVariant &value); +/*! \fn void guhserver::GuhCore::deviceStateChanged(Device *device, const QUuid &stateTypeId, const QVariant &value); This signal is emitted when the \l{State} of a \a device changed. The \a stateTypeId parameter describes the \l{StateType} and the \a value parameter holds the new value. */ -/*! \fn void GuhCore::deviceRemoved(const DeviceId &deviceId); +/*! \fn void guhserver::GuhCore::deviceRemoved(const DeviceId &deviceId); This signal is emitted when a \l{Device} with the given \a deviceId was removed. */ -/*! \fn void GuhCore::deviceAdded(Device *device); +/*! \fn void guhserver::GuhCore::deviceAdded(Device *device); This signal is emitted when a \a device was added to the system. */ -/*! \fn void GuhCore::deviceParamsChanged(Device *device); +/*! \fn void guhserver::GuhCore::deviceParamsChanged(Device *device); This signal is emitted when the \l{ParamList}{Params} of a \a device have been changed. */ -/*! \fn void GuhCore::actionExecuted(const ActionId &id, DeviceManager::DeviceError status); +/*! \fn void guhserver::GuhCore::actionExecuted(const ActionId &id, DeviceManager::DeviceError status); This signal is emitted when the \l{Action} with the given \a id is finished. The \a status of the \l{Action} execution will be described as \l{DeviceManager::DeviceError}{DeviceError}. */ -/*! \fn void GuhCore::devicesDiscovered(const DeviceClassId &deviceClassId, const QList deviceDescriptors); +/*! \fn void guhserver::GuhCore::devicesDiscovered(const DeviceClassId &deviceClassId, const QList deviceDescriptors); This signal is emitted when the discovery of a \a deviceClassId is finished. The \a deviceDescriptors parameter describes the list of \l{DeviceDescriptor}{DeviceDescriptors} of all discovered \l{Device}{Devices}. \sa discoverDevices() */ -/*! \fn void GuhCore::deviceSetupFinished(Device *device, DeviceManager::DeviceError status); +/*! \fn void guhserver::GuhCore::deviceSetupFinished(Device *device, DeviceManager::DeviceError status); This signal is emitted when the setup of a \a device is finished. The \a status parameter describes the \l{DeviceManager::DeviceError}{DeviceError} that occurred. */ -/*! \fn void GuhCore::deviceEditFinished(Device *device, DeviceManager::DeviceError status); +/*! \fn void guhserver::GuhCore::deviceEditFinished(Device *device, DeviceManager::DeviceError status); This signal is emitted when the edit request of a \a device is finished. The \a status of the edit request will be described as \l{DeviceManager::DeviceError}{DeviceError}. */ -/*! \fn void GuhCore::pairingFinished(const PairingTransactionId &pairingTransactionId, DeviceManager::DeviceError status, const DeviceId &deviceId); +/*! \fn void guhserver::GuhCore::pairingFinished(const PairingTransactionId &pairingTransactionId, DeviceManager::DeviceError status, const DeviceId &deviceId); The DeviceManager will emit a this Signal when the pairing of a \l{Device} with the \a deviceId and \a pairingTransactionId is finished. The \a status of the pairing will be described as \l{DeviceManager::DeviceError}{DeviceError}. */ -/*! \fn void GuhCore::ruleRemoved(const RuleId &ruleId); +/*! \fn void guhserver::GuhCore::ruleRemoved(const RuleId &ruleId); This signal is emitted when a \l{Rule} with the given \a ruleId was removed. */ -/*! \fn void GuhCore::ruleAdded(const Rule &rule); +/*! \fn void guhserver::GuhCore::ruleAdded(const Rule &rule); This signal is emitted when a \a rule was added to the system. */ -/*! \fn void GuhCore::ruleConfigurationChanged(const Rule &rule); +/*! \fn void guhserver::GuhCore::ruleConfigurationChanged(const Rule &rule); This signal is emitted when the configuration of \a rule changed. */ diff --git a/server/httpreply.cpp b/server/httpreply.cpp index 885aed84..40bf40c4 100644 --- a/server/httpreply.cpp +++ b/server/httpreply.cpp @@ -19,11 +19,11 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /*! - \class HttpReply + \class guhserver::HttpReply \brief Represents a reply of the guh webserver. - \ingroup types - \inmodule libguh + \ingroup core + \inmodule server This class holds the header and the payload data of a network reply and represents a response from the guh webserver. @@ -32,7 +32,7 @@ */ -/*! \enum HttpReply::HttpStatusCode +/*! \enum guhserver::HttpReply::HttpStatusCode This enum type specifies the status code of a HTTP webserver reply. @@ -72,7 +72,7 @@ ... */ -/*! \enum HttpReply::HttpHeaderType +/*! \enum guhserver::HttpReply::HttpHeaderType This enum type specifies the known type of a header in a HTTP webserver reply. @@ -96,7 +96,7 @@ ... */ -/*! \enum HttpReply::Type +/*! \enum guhserver::HttpReply::Type */ @@ -106,6 +106,8 @@ #include #include +namespace guhserver { + /*! Construct a HttpReply with the given \a statusCode. */ HttpReply::HttpReply(QObject *parent) : QObject(parent), @@ -352,3 +354,5 @@ void HttpReply::timeout() m_timedOut = true; emit finished(); } + +} diff --git a/server/httpreply.h b/server/httpreply.h index 8e301c81..a5f1a154 100644 --- a/server/httpreply.h +++ b/server/httpreply.h @@ -29,6 +29,8 @@ // Note: RFC 7231 HTTP/1.1 Semantics and Content -> http://tools.ietf.org/html/rfc7231 +namespace guhserver { + class HttpReply: public QObject { Q_OBJECT @@ -128,7 +130,8 @@ public slots: signals: void finished(); - }; +} + #endif // HTTPREPLY_H diff --git a/server/httprequest.cpp b/server/httprequest.cpp index dada315b..96597bcf 100644 --- a/server/httprequest.cpp +++ b/server/httprequest.cpp @@ -23,6 +23,7 @@ #include +namespace guhserver { HttpRequest::HttpRequest() : m_rawData(QByteArray()), @@ -217,3 +218,5 @@ QDebug operator<<(QDebug debug, const HttpRequest &httpRequest) debug << "-----------------------------------" << "\n"; return debug; } + +} diff --git a/server/httprequest.h b/server/httprequest.h index 5b7b02c4..07cd7b69 100644 --- a/server/httprequest.h +++ b/server/httprequest.h @@ -26,6 +26,8 @@ #include #include +namespace guhserver { + class HttpRequest { public: @@ -81,4 +83,5 @@ private: QDebug operator<< (QDebug debug, const HttpRequest &httpRequest); +} #endif // HTTPREQUEST_H diff --git a/server/qtservice/qtservice.cpp b/server/qtservice/qtservice.cpp index 8ec20fff..2e65edaa 100644 --- a/server/qtservice/qtservice.cpp +++ b/server/qtservice/qtservice.cpp @@ -204,7 +204,6 @@ void qtServiceLogDebug(QtMsgType type, const char* msg) \sa startupType() */ -namespace guhserver { /*! Creates a controller object for the service with the given @@ -1114,4 +1113,4 @@ void QtServiceBase::processCommand(int /*code*/) \reimp */ -} + diff --git a/server/qtservice/qtservice.h b/server/qtservice/qtservice.h index d3310a91..86c4d3da 100644 --- a/server/qtservice/qtservice.h +++ b/server/qtservice/qtservice.h @@ -60,8 +60,6 @@ # define QT_QTSERVICE_EXPORT #endif -namespace guhserver { - class QtServiceControllerPrivate; class QT_QTSERVICE_EXPORT QtServiceController @@ -190,6 +188,4 @@ private: }; Q_DECLARE_OPERATORS_FOR_FLAGS(QtServiceBase::ServiceFlags) -} - #endif // QTSERVICE_H diff --git a/server/qtservice/qtservice_p.h b/server/qtservice/qtservice_p.h index d9363c22..a88992cf 100644 --- a/server/qtservice/qtservice_p.h +++ b/server/qtservice/qtservice_p.h @@ -44,8 +44,6 @@ #include #include "qtservice.h" -namespace guhserver { - class QtServiceControllerPrivate { Q_DECLARE_PUBLIC(QtServiceController) @@ -86,6 +84,4 @@ public: class QtServiceSysPrivate *sysd; }; -} - #endif diff --git a/server/qtservice/qtservice_unix.cpp b/server/qtservice/qtservice_unix.cpp index 815adfac..c7632f3d 100644 --- a/server/qtservice/qtservice_unix.cpp +++ b/server/qtservice/qtservice_unix.cpp @@ -60,8 +60,6 @@ #include #include -namespace guhserver { - static QString encodeName(const QString &name, bool allowUpper = false) { QString n = name.toLower(); @@ -474,5 +472,3 @@ void QtServiceBase::setServiceFlags(QtServiceBase::ServiceFlags flags) if (d_ptr->sysd) d_ptr->sysd->serviceFlags = flags; } - -} diff --git a/server/qtservice/qtservice_win.cpp b/server/qtservice/qtservice_win.cpp index 0218dd9b..f192f905 100644 --- a/server/qtservice/qtservice_win.cpp +++ b/server/qtservice/qtservice_win.cpp @@ -62,8 +62,6 @@ #include #endif -namespace guhserver { - typedef SERVICE_STATUS_HANDLE(WINAPI*PRegisterServiceCtrlHandler)(const wchar_t*,LPHANDLER_FUNCTION); static PRegisterServiceCtrlHandler pRegisterServiceCtrlHandler = 0; typedef BOOL(WINAPI*PSetServiceStatus)(SERVICE_STATUS_HANDLE,LPSERVICE_STATUS); @@ -943,5 +941,3 @@ void QtServiceBase::setServiceFlags(QtServiceBase::ServiceFlags flags) if (d_ptr->sysd) d_ptr->sysd->setServiceFlags(flags); } - -} diff --git a/server/qtservice/qtunixserversocket.cpp b/server/qtservice/qtunixserversocket.cpp index d1dbcee0..97fad137 100644 --- a/server/qtservice/qtunixserversocket.cpp +++ b/server/qtservice/qtunixserversocket.cpp @@ -45,8 +45,6 @@ #include #include -namespace guhserver { - #ifndef SUN_LEN #define SUN_LEN(ptr) ((size_t)(((struct sockaddr_un *) 0)->sun_path) \ +strlen ((ptr)->sun_path)) @@ -93,4 +91,3 @@ void QtUnixServerSocket::close() } } -} diff --git a/server/qtservice/qtunixserversocket.h b/server/qtservice/qtunixserversocket.h index 7c750555..88161ee5 100644 --- a/server/qtservice/qtunixserversocket.h +++ b/server/qtservice/qtunixserversocket.h @@ -43,8 +43,6 @@ #include -namespace guhserver { - class QtUnixServerSocket : public QTcpServer { Q_OBJECT @@ -59,6 +57,4 @@ private: QString path_; }; -} - #endif diff --git a/server/qtservice/qtunixsocket.cpp b/server/qtservice/qtunixsocket.cpp index 9c81d702..d3706004 100644 --- a/server/qtservice/qtunixsocket.cpp +++ b/server/qtservice/qtunixsocket.cpp @@ -50,8 +50,6 @@ +strlen ((ptr)->sun_path)) #endif -namespace guhserver { - QtUnixSocket::QtUnixSocket(QObject *parent) : QTcpSocket(parent) { @@ -79,4 +77,3 @@ bool QtUnixSocket::connectTo(const QString &path) return ret; } -} diff --git a/server/qtservice/qtunixsocket.h b/server/qtservice/qtunixsocket.h index 4f4eb1db..1d34fba4 100644 --- a/server/qtservice/qtunixsocket.h +++ b/server/qtservice/qtunixsocket.h @@ -43,8 +43,6 @@ #include -namespace guhserver { - class QtUnixSocket : public QTcpSocket { Q_OBJECT @@ -54,5 +52,4 @@ public: bool connectTo(const QString &path); }; -} #endif diff --git a/server/rest/deviceclassesresource.h b/server/rest/deviceclassesresource.h index 07cf4fc8..11397156 100644 --- a/server/rest/deviceclassesresource.h +++ b/server/rest/deviceclassesresource.h @@ -28,10 +28,11 @@ #include "restresource.h" #include "httpreply.h" -class HttpRequest; namespace guhserver { +class HttpRequest; + class DeviceClassesResource : public RestResource { Q_OBJECT diff --git a/server/rest/devicesresource.h b/server/rest/devicesresource.h index 3fd29d68..e88b587d 100644 --- a/server/rest/devicesresource.h +++ b/server/rest/devicesresource.h @@ -28,10 +28,10 @@ #include "restresource.h" #include "httpreply.h" -class HttpRequest; - namespace guhserver { +class HttpRequest; + class DevicesResource: public RestResource { Q_OBJECT diff --git a/server/rest/logsresource.h b/server/rest/logsresource.h index fda26e22..8c293df5 100644 --- a/server/rest/logsresource.h +++ b/server/rest/logsresource.h @@ -28,10 +28,10 @@ #include "restresource.h" #include "httpreply.h" -class HttpRequest; - namespace guhserver { +class HttpRequest; + class LogsResource : public RestResource { Q_OBJECT diff --git a/server/rest/pluginsresource.h b/server/rest/pluginsresource.h index 3bae2740..f4963a81 100644 --- a/server/rest/pluginsresource.h +++ b/server/rest/pluginsresource.h @@ -28,10 +28,10 @@ #include "restresource.h" #include "httpreply.h" -class HttpRequest; - namespace guhserver { +class HttpRequest; + class PluginsResource : public RestResource { Q_OBJECT diff --git a/server/rest/restserver.h b/server/rest/restserver.h index 9e3be6c5..3d441731 100644 --- a/server/rest/restserver.h +++ b/server/rest/restserver.h @@ -32,12 +32,13 @@ #include "rulesresource.h" #include "logsresource.h" -class HttpRequest; -class HttpReply; class QSslConfiguration; namespace guhserver { +class HttpRequest; +class HttpReply; + class RestServer : public QObject { Q_OBJECT diff --git a/server/rest/rulesresource.h b/server/rest/rulesresource.h index 4b2409e8..6292a2d1 100644 --- a/server/rest/rulesresource.h +++ b/server/rest/rulesresource.h @@ -28,10 +28,11 @@ #include "restresource.h" #include "httpreply.h" -class HttpRequest; namespace guhserver { +class HttpRequest; + class RulesResource : public RestResource { Q_OBJECT diff --git a/server/rest/vendorsresource.h b/server/rest/vendorsresource.h index 14f7b4b0..8b993e18 100644 --- a/server/rest/vendorsresource.h +++ b/server/rest/vendorsresource.h @@ -28,10 +28,10 @@ #include "restresource.h" #include "httpreply.h" -class HttpRequest; - namespace guhserver { +class HttpRequest; + class VendorsResource : public RestResource { Q_OBJECT diff --git a/server/rule.cpp b/server/rule.cpp index f0874f28..26cbda22 100644 --- a/server/rule.cpp +++ b/server/rule.cpp @@ -20,7 +20,7 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /*! - \class Rule + \class guhserver::Rule \brief This class represents a rule. \ingroup core diff --git a/server/ruleengine.cpp b/server/ruleengine.cpp index 5de59650..a30b91c4 100644 --- a/server/ruleengine.cpp +++ b/server/ruleengine.cpp @@ -20,7 +20,7 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /*! - \class RuleEngine + \class guhserver::RuleEngine \brief The Engine that evaluates \l{Rule}{Rules} and finds \l{Action}{Actions} to be executed. @@ -33,20 +33,20 @@ \sa Event, EventDescriptor, Rule, RuleAction */ -/*! \fn void RuleEngine::ruleAdded(const Rule &rule) +/*! \fn void guhserver::RuleEngine::ruleAdded(const Rule &rule) Will be emitted whenever a new \l{Rule} is added to this Engine. The \a rule parameter holds the entire new rule.*/ -/*! \fn void RuleEngine::ruleRemoved(const RuleId &ruleId) +/*! \fn void guhserver::RuleEngine::ruleRemoved(const RuleId &ruleId) Will be emitted whenever a \l{Rule} is removed from this Engine. \a ruleId holds the id of the removed rule. You should remove any references or copies you hold for this rule.*/ -/*! \fn void RuleEngine::ruleConfigurationChanged(const Rule &rule) +/*! \fn void guhserver::RuleEngine::ruleConfigurationChanged(const Rule &rule) Will be emitted whenever a \l{Rule} changed his enable/disable status. The parameter \a rule holds the changed rule.*/ -/*! \enum RuleEngine::RuleError +/*! \enum guhserver::RuleEngine::RuleError \value RuleErrorNoError No error happened. Everything is fine. \value RuleErrorInvalidRuleId @@ -71,7 +71,7 @@ One of the RuleActionParams type does not match with the corresponding EventParam type. */ -/*! \enum RuleEngine::RemovePolicy +/*! \enum guhserver::RuleEngine::RemovePolicy \value RemovePolicyCascade Remove the whole \l{Rule}. \value RemovePolicyUpdate diff --git a/server/webserver.h b/server/webserver.h index 801d3595..bbe79960 100644 --- a/server/webserver.h +++ b/server/webserver.h @@ -31,14 +31,14 @@ #include #include -class HttpRequest; -class HttpReply; - // Note: Hypertext Transfer Protocol (HTTP/1.1) from the Internet Engineering Task Force (IETF): // https://tools.ietf.org/html/rfc7231 namespace guhserver { +class HttpRequest; +class HttpReply; + class WebServer : public QTcpServer { Q_OBJECT