Added comments in code

Author: ThomasTJdev

src/nmqtt_pub.nim

@@ -9,6 +9,7 @@ proc nmqttPub(host="127.0.0.1", port: int=1883, ssl:bool=false, clientid="", use
   let ctx = newMqttCtx(if clientid != "": clientid else: "nmqtt_pub_" & $getCurrentProcessId())
   ctx.set_host(host, port, ssl)
 
+  # Set the will message
   if willretain and (willtopic == "" or willmsg == ""):
     echo "Error: Will-retain giving, but no topic given"
     quit()
@@ -51,22 +52,22 @@ $options
           doc="Publish MQTT messages to a MQTT-broker.",
           cmdName="nmqtt_pub",
           help={
-            "host":     "IP-address of the broker.",
-            "port":     "network port to connect too.",
-            "ssl":      "enable ssl. Auto-enabled on port 8883.",
-            "clientid": "your connection ID. Defaults to nmqtt_pub_ appended with processID.",
-            "username": "provide a username",
-            "password": "provide a password",
-            "topic":    "mqtt topic to publish to.",
-            "msg":      "message payload to send.",
-            "qos":      "quality of service level to use for all messages.",
-            "retain":   "retain messages on the broker.",
-            "repeat":   "repeat the publish N times.",
-            "repeatdelay":"if using --repeat, wait N seconds between publish. Defaults to 0.",
-            "willtopic":"set the will's topic",
-            "willmsg":  "set the will's message",
-            "willqos":  "set the will's quality of service",
-            "willretain":"set to retain the will message"
+            "host":         "IP-address of the broker.",
+            "port":         "network port to connect too.",
+            "ssl":          "enable ssl. Auto-enabled on port 8883.",
+            "clientid":     "your connection ID. Defaults to nmqtt_pub_ appended with processID.",
+            "username":     "provide a username",
+            "password":     "provide a password",
+            "topic":        "mqtt topic to publish to.",
+            "msg":          "message payload to send.",
+            "qos":          "quality of service level to use for all messages.",
+            "retain":       "retain messages on the broker.",
+            "repeat":       "repeat the publish N times.",
+            "repeatdelay":  "if using --repeat, wait N seconds between publish. Defaults to 0.",
+            "willtopic":    "set the will's topic",
+            "willmsg":      "set the will's message",
+            "willqos":      "set the will's quality of service",
+            "willretain":   "set to retain the will message"
           },
           short={
             "password": 'P',

src/nmqtt_sub.nim

@@ -23,25 +23,31 @@ proc nmqttSub(host="127.0.0.1", port: int=1883, ssl:bool=false, clientid="", use
   else:
     ctx.set_host(host, port, ssl)
 
+  # Set the ping interval/keep alive
   ctx.set_ping_interval(keepalive)
 
+  # Set the will message
   if willretain and (willtopic == "" or willmsg == ""):
     echo "Error: Will-retain giving, but no topic given"
     quit(0)
   elif willtopic != "" and willmsg != "":
     ctx.set_will(willtopic, willmsg, willqos, willretain)
 
+  # Connec to broker
   await ctx.start()
 
   # Remove retained messages
   if removeretained:
     waitFor ctx.publish(topic, "", 0, true)
 
+  # Callback for subscribe
   proc on_data(topic, msg: string) =
     echo topic, ": ", msg
 
+  # Subscribe to topic
   await ctx.subscribe(topic, qos, on_data)
 
+  # Control CTRL+c hook
   setControlCHook(handler)
 
   runForever()