From c826a165b8a363ac3d2ad3fe88b2ba145a2dd640 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20St=C3=BCrz?= <simon.stuerz@guh.io>
Date: Fri, 21 Feb 2020 13:02:50 +0100
Subject: [PATCH] Add qdoc configuration file for standalone build and create
 index.html for classes overview

---
 .gitignore                         |  1 +
 docs/config.qdocconf               | 33 ++++++++++++++++++++++++++++++
 docs/index.qdoc                    |  8 ++++++++
 libnymea-mqtt/mqttclient.cpp       |  2 ++
 libnymea-mqtt/mqttsubscription.cpp |  2 ++
 5 files changed, 46 insertions(+)
 create mode 100644 docs/config.qdocconf
 create mode 100644 docs/index.qdoc

diff --git a/.gitignore b/.gitignore
index 1cd3ed2..1935770 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 *.user
 .crossbuilder
+docs/nymea-mqtt-raw/
diff --git a/docs/config.qdocconf b/docs/config.qdocconf
new file mode 100644
index 0000000..843d985
--- /dev/null
+++ b/docs/config.qdocconf
@@ -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 \
+
+
diff --git a/docs/index.qdoc b/docs/index.qdoc
new file mode 100644
index 0000000..cfbe01d
--- /dev/null
+++ b/docs/index.qdoc
@@ -0,0 +1,8 @@
+/*!
+    \page index.html
+    \title nymea-mqtt documentation
+
+    \chapter Classes
+    \annotatedlist mqtt
+
+*/
diff --git a/libnymea-mqtt/mqttclient.cpp b/libnymea-mqtt/mqttclient.cpp
index 5f25db3..e164e89 100644
--- a/libnymea-mqtt/mqttclient.cpp
+++ b/libnymea-mqtt/mqttclient.cpp
@@ -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.
diff --git a/libnymea-mqtt/mqttsubscription.cpp b/libnymea-mqtt/mqttsubscription.cpp
index 918a964..cefe9a5 100644
--- a/libnymea-mqtt/mqttsubscription.cpp
+++ b/libnymea-mqtt/mqttsubscription.cpp
@@ -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.
 */