mirror of https://github.com/nymea/nymea-mqtt
Add qdoc configuration file for standalone build and create index.html for classes overview
parent
c6f48d2229
commit
c826a165b8
|
|
@ -1,2 +1,3 @@
|
||||||
*.user
|
*.user
|
||||||
.crossbuilder
|
.crossbuilder
|
||||||
|
docs/nymea-mqtt-raw/
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,33 @@
|
||||||
|
project = nymea-mqtt
|
||||||
|
description = nymea-mqtt documentation
|
||||||
|
|
||||||
|
dita.metadata.default.author = Michael Zanetti
|
||||||
|
dita.metadata.default.permissions = all
|
||||||
|
dita.metadata.default.publisher = nymea GmbH
|
||||||
|
dita.metadata.default.copyryear = 2020
|
||||||
|
dita.metadata.default.copyrholder = Michael Zanetti
|
||||||
|
dita.metadata.default.audience = programmer
|
||||||
|
|
||||||
|
outputdir = nymea-mqtt-raw
|
||||||
|
outputformats = HTML
|
||||||
|
|
||||||
|
language = Cpp
|
||||||
|
|
||||||
|
naturallanguage = en_US
|
||||||
|
outputencoding = UTF-8
|
||||||
|
sourceencoding = UTF-8
|
||||||
|
|
||||||
|
#syntaxhighlighting = true
|
||||||
|
|
||||||
|
headerdirs = ../libnymea-mqtt
|
||||||
|
sourcedirs = ./ ../libnymea-mqtt
|
||||||
|
|
||||||
|
headers.fileextensions = "*.h"
|
||||||
|
sources.fileextensions = "*.cpp *.qdoc"
|
||||||
|
|
||||||
|
Cpp.ignoredirectives = Q_DECLARE_METATYPE \
|
||||||
|
Q_LOGGING_CATEGORY \
|
||||||
|
Q_DECLARE_LOGGING_CATEGORY \
|
||||||
|
Q_ENUM \
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
/*!
|
||||||
|
\page index.html
|
||||||
|
\title nymea-mqtt documentation
|
||||||
|
|
||||||
|
\chapter Classes
|
||||||
|
\annotatedlist mqtt
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
@ -28,6 +28,8 @@
|
||||||
/*!
|
/*!
|
||||||
\class MqttClient
|
\class MqttClient
|
||||||
\brief A MQTT client
|
\brief A MQTT client
|
||||||
|
\inmodule nymea-mqtt
|
||||||
|
\ingroup mqtt
|
||||||
|
|
||||||
MqttClient is used to connect to MQTT servers/brokers. The currently supported
|
MqttClient is used to connect to MQTT servers/brokers. 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.
|
||||||
|
|
|
||||||
|
|
@ -28,6 +28,8 @@
|
||||||
/*!
|
/*!
|
||||||
\class MqttSubscription
|
\class MqttSubscription
|
||||||
\brief A helper class for managing MQTT subscription filters
|
\brief A helper class for managing MQTT subscription filters
|
||||||
|
\inmodule nymea-mqtt
|
||||||
|
\ingroup mqtt
|
||||||
|
|
||||||
Bundles topic filter and QoS type into a single data type.
|
Bundles topic filter and QoS type into a single data type.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue