From f1116274cf57fbb7be30378de0d7739d9bf47049 Mon Sep 17 00:00:00 2001
From: Detlef Justen <150811405+DeJusten@users.noreply.github.com>
Date: Tue, 14 Jan 2025 18:17:37 +0100
Subject: [PATCH] Update doc.txt

Add some Information about the paho stack
---
 pkg/paho-mqtt/doc.txt | 28 +++++++++++++++++++++-------
 1 file changed, 21 insertions(+), 7 deletions(-)

diff --git a/pkg/paho-mqtt/doc.txt b/pkg/paho-mqtt/doc.txt
index 15ade916c370..bab50af09fc3 100644
--- a/pkg/paho-mqtt/doc.txt
+++ b/pkg/paho-mqtt/doc.txt
@@ -1,9 +1,23 @@
 /**
- * @defgroup pkg_paho_mqtt   PAHO MQTT framework
- * @ingroup  pkg
- * @brief    The Eclipse Paho project provides open-source client implementations of MQTT for embedded systems
- * @see      https://github.com/eclipse/paho.mqtt.embedded-c
- *
- * The Eclipse Paho project provides open-source client
- * implementations of MQTT.
+ @defgroup pkg_paho_mqtt   PAHO MQTT framework
+ @ingroup  pkg
+ @brief    The Eclipse Paho project provides open-source client implementations of MQTT for embedded systems
+ @see      https://github.com/eclipse/paho.mqtt.embedded-c
+ 
+ The Eclipse Paho project provides open-source client
+ implementations of MQTT.
+
+  # Supported MQTT Protocol Version
+
+  The supported protocol version of the used paho.mqtt.embedded-c stack is
+    - MQTT-Version = 3.1 (MQTTVersion struct member of MQTTPacket_connectData = 3)
+	  - MQTT-Version = 3.1.1 (MQTTVersion struct member of MQTTPacket_connectData = 4)
+	
+  # Implementation specific information
+
+  - The Main-Loop is running in the Task mqtt_riot_run() with a default-cyclus of 30ms (MQTT_YIELD_POLLING_MS) 
+    and an default duration of 10ms (PAHO_MQTT_YIELD_MS)
+  - During publish a topic with MQTTPublish() and QoS>0, the functions blocks until 
+    it receive des One Acknowledge (QoS=1) or two Acknowledges (Qos=2).
+
  */