Typo + documentation extended

Dirk007 · Dirk007 · commit b546452a6053 · 2018-03-10T13:21:25.000+01:00
diff --git a/mqttGuard.cpp b/mqttGuard.cpp
@@ -11,7 +11,7 @@ MqttGuard::MqttGuard(basecampLog::LogCallback logCallback)
 void MqttGuard::registerPacket(IdType packetId)
 {
     if (!isValidPacketId(packetId)) {
-        tryLog(basecampLog::Severity::info, "Not registering invlaid MQTT-packet.", packetId);
+        tryLog(basecampLog::Severity::info, "Not registering invalid MQTT-packet.", packetId);
         return;
     }
 
diff --git a/mqttGuard.hpp b/mqttGuard.hpp
@@ -8,8 +8,8 @@
 
 /**
   Helper to guard outgoing mqtt packets.
-  On packet sending, register the packets within this class and
-  pull the empty() function to see if everything has been sent completely.
+  On packet sending, register the packets within this class, unregister them within the onPublish and
+  pull the allSent() function to see if everything has been sent completely.
 */
 class MqttGuard
 {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ MqttGuard::MqttGuard(basecampLog::LogCallback logCallback)`
`11`	`11`	`void MqttGuard::registerPacket(IdType packetId)`
`12`	`12`	`{`
`13`	`13`	`if (!isValidPacketId(packetId)) {`
`14`		`- tryLog(basecampLog::Severity::info, "Not registering invlaid MQTT-packet.", packetId);`
	`14`	`+ tryLog(basecampLog::Severity::info, "Not registering invalid MQTT-packet.", packetId);`
`15`	`15`	`return;`
`16`	`16`	`}`
`17`	`17`