Add inmodule for classes and provide the classes list in the index.qdoc
This commit is contained in:
parent
c826a165b8
commit
ab29879f4e
@ -8,7 +8,7 @@ dita.metadata.default.copyryear = 2020
|
||||
dita.metadata.default.copyrholder = Michael Zanetti
|
||||
dita.metadata.default.audience = programmer
|
||||
|
||||
outputdir = nymea-mqtt-raw
|
||||
outputdir = nymea-mqtt-html
|
||||
outputformats = HTML
|
||||
|
||||
language = Cpp
|
||||
|
||||
@ -28,6 +28,8 @@
|
||||
/*!
|
||||
\class MqttPacket
|
||||
\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
|
||||
payload incoming from the network.
|
||||
|
||||
@ -28,6 +28,8 @@
|
||||
/*!
|
||||
\class MqttServer
|
||||
\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
|
||||
MQTT protocol version is 3.1.1 including SSL encryption support.
|
||||
@ -47,6 +49,8 @@
|
||||
/*!
|
||||
\class MqttAuthorizer
|
||||
\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.
|
||||
The \l MqttServer will call the authorizer methods on any incoming connect, publish or subscribe
|
||||
|
||||
Reference in New Issue
Block a user