From ab29879f4e49c31162e962af1d74bb2fd83e42f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 21 Feb 2020 13:10:39 +0100 Subject: [PATCH] Add inmodule for classes and provide the classes list in the index.qdoc --- docs/config.qdocconf | 2 +- libnymea-mqtt/mqttpacket.cpp | 2 ++ libnymea-mqtt/mqttserver.cpp | 4 ++++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/config.qdocconf b/docs/config.qdocconf index 843d985..e58cf2b 100644 --- a/docs/config.qdocconf +++ b/docs/config.qdocconf @@ -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 diff --git a/libnymea-mqtt/mqttpacket.cpp b/libnymea-mqtt/mqttpacket.cpp index d1d4dc7..db423de 100644 --- a/libnymea-mqtt/mqttpacket.cpp +++ b/libnymea-mqtt/mqttpacket.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. diff --git a/libnymea-mqtt/mqttserver.cpp b/libnymea-mqtt/mqttserver.cpp index 9f42e05..72861ed 100644 --- a/libnymea-mqtt/mqttserver.cpp +++ b/libnymea-mqtt/mqttserver.cpp @@ -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