Add qdoc configuration file for standalone build and create index.html for classes overview
This commit is contained in:
parent
c6f48d2229
commit
c826a165b8
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,2 +1,3 @@
|
||||
*.user
|
||||
.crossbuilder
|
||||
docs/nymea-mqtt-raw/
|
||||
|
||||
33
docs/config.qdocconf
Normal file
33
docs/config.qdocconf
Normal file
@ -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 \
|
||||
|
||||
|
||||
8
docs/index.qdoc
Normal file
8
docs/index.qdoc
Normal file
@ -0,0 +1,8 @@
|
||||
/*!
|
||||
\page index.html
|
||||
\title nymea-mqtt documentation
|
||||
|
||||
\chapter Classes
|
||||
\annotatedlist mqtt
|
||||
|
||||
*/
|
||||
@ -28,6 +28,8 @@
|
||||
/*!
|
||||
\class MqttClient
|
||||
\brief A MQTT client
|
||||
\inmodule nymea-mqtt
|
||||
\ingroup mqtt
|
||||
|
||||
MqttClient is used to connect to MQTT servers/brokers. The currently supported
|
||||
MQTT protocol version is 3.1.1 including SSL encryption support.
|
||||
|
||||
@ -28,6 +28,8 @@
|
||||
/*!
|
||||
\class MqttSubscription
|
||||
\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.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user