added documentation to publish functions

Author: hmueller01

Diff for: src/MqttClient.cpp

@@ -259,6 +259,17 @@ int MqttClient::endMessage()
   return 1;
 }
 
+/**
+ * @brief  Pubish a MQTT messages to the broker.
+ * 
+ * @param  topic The topic to publish to. 
+ * @param  payload The payload to publish.
+ * @param  retain Publish the MQTT message with the retain flag. Default false.
+ * @param  qos The Quality of Service of the MQTT message. [0 .. 2]. Default 0.
+ * @param  dup Set or reset the duplicate flag of MQTT message. Default false (reset).
+ * @return 0 - Failed to send message.
+ *         1 - Successfully send message.
+ */
 int MqttClient::publish(const char* topic, const char* payload, bool retain, uint8_t qos, bool dup) {
   int ret = beginMessage(topic, strlen_P(payload), retain, qos, dup);
   if (!ret) {
@@ -269,14 +280,47 @@ int MqttClient::publish(const char* topic, const char* payload, bool retain, uin
   return ret;
 }
 
+/**
+ * @brief  Pubish a MQTT messages to the broker.
+ * 
+ * @param  topic The topic to publish to. 
+ * @param  payload The payload to publish.
+ * @param  retain Publish the MQTT message with the retain flag. Default false.
+ * @param  qos The Quality of Service of the MQTT message. [0 .. 2]. Default 0.
+ * @param  dup Set or reset the duplicate flag of MQTT message. Default false (reset).
+ * @return 0 - Failed to send message.
+ *         1 - Successfully send message.
+ */
 int MqttClient::publish(const String& topic, const char* payload, bool retain, uint8_t qos, bool dup) {
   return publish(topic.c_str(), payload, retain, qos, dup);
 }
 
+/**
+ * @brief  Pubish a MQTT messages to the broker.
+ * 
+ * @param  topic The topic to publish to. 
+ * @param  payload The payload to publish.
+ * @param  retain Publish the MQTT message with the retain flag. Default false.
+ * @param  qos The Quality of Service of the MQTT message. [0 .. 2]. Default 0.
+ * @param  dup Set or reset the duplicate flag of MQTT message. Default false (reset).
+ * @return 0 - Failed to send message.
+ *         1 - Successfully send message.
+ */
 int MqttClient::publish(const char* topic, String& payload, bool retain, uint8_t qos, bool dup) {
   return publish(topic, payload.c_str(), retain, qos, dup);
 }
 
+/**
+ * @brief  Pubish a MQTT messages to the broker.
+ * 
+ * @param  topic The topic to publish to. 
+ * @param  payload The payload to publish.
+ * @param  retain Publish the MQTT message with the retain flag. Default false.
+ * @param  qos The Quality of Service of the MQTT message. [0 .. 2]. Default 0.
+ * @param  dup Set or reset the duplicate flag of MQTT message. Default false (reset).
+ * @return 0 - Failed to send message.
+ *         1 - Successfully send message.
+ */
 int MqttClient::publish(const String& topic, String& payload, bool retain, uint8_t qos, bool dup) {
   return publish(topic.c_str(), payload.c_str(), retain, qos, dup);
 }