ETM-Schurig
/
nymea-mqtt
mirror of https://github.com/nymea/nymea-mqtt
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add inmodule for classes and provide the classes list in the index.qdoc

pull/10/head
Simon Stürz 2020-02-21 13:10:39 +01:00
parent c826a165b8
commit ab29879f4e
3 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/config.qdocconf
View File

@ -8,7 +8,7 @@ dita.metadata.default.copyryear = 2020
dita.metadata.default.copyrholder = Michael Zanetti dita.metadata.default.copyrholder = Michael Zanetti
dita.metadata.default.audience = programmer dita.metadata.default.audience = programmer
outputdir = nymea-mqtt-raw outputdir = nymea-mqtt-html
outputformats = HTML outputformats = HTML
language = Cpp language = Cpp

2
libnymea-mqtt/mqttpacket.cpp
View File

@ -28,6 +28,8 @@
/*! /*!
\class MqttPacket \class MqttPacket
\brief Defines a MQTT packet and serialzes/deserializes to/from network payload. \brief Defines a MQTT packet and serialzes/deserializes to/from network payload.
\inmodule nymea-mqtt
\ingroup mqtt
MqttPacket is used to create MQTT packets to be sent over the network or parse packet MqttPacket is used to create MQTT packets to be sent over the network or parse packet
payload incoming from the network. payload incoming from the network.

4
libnymea-mqtt/mqttserver.cpp
View File

@ -28,6 +28,8 @@
/*! /*!
\class MqttServer \class MqttServer
\brief A MQTT server implementation \brief A MQTT server implementation
\inmodule nymea-mqtt
\ingroup mqtt
MqttServer is used to expose a MQTT server interface in the network. The currently supported MqttServer is used to expose a MQTT server interface in the network. The currently supported
MQTT protocol version is 3.1.1 including SSL encryption support. MQTT protocol version is 3.1.1 including SSL encryption support.
@ -47,6 +49,8 @@
/*! /*!
\class MqttAuthorizer \class MqttAuthorizer
\brief Authorizer base class for authorizing incoming client connections on an \l MqttServer \brief Authorizer base class for authorizing incoming client connections on an \l MqttServer
\inmodule nymea-mqtt
\ingroup mqtt
MqttAuthorizer is the base class for authorization handlers in \l MqttServer interfaces. MqttAuthorizer is the base class for authorization handlers in \l MqttServer interfaces.
The \l MqttServer will call the authorizer methods on any incoming connect, publish or subscribe The \l MqttServer will call the authorizer methods on any incoming connect, publish or subscribe