Bug: 483544 - Correct documentation regarding deletion of retained message

jpwsutton · jpwsutton · commit f21837ef8f48 · 2015-12-07T14:16:36.000Z
Fixed the incorrect documentation on retained flag.
Signed-off-by: James Sutton &lt;james.sutton@uk.ibm.com&gt;
diff --git a/org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttMessage.java b/org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttMessage.java
@@ -112,7 +112,8 @@ public boolean isRetained() {
 
 	/**
 	 * Whether or not the publish message should be retained by the messaging engine.
-	 * Sending a message with the retained set to <code>false</code> will clear the
+	 * Sending a message with retained set to <code>true</code> and with an empty
+         * byte array as the payload e.g. <code>new byte[0]</code> will clear the
 	 * retained message from the server.  The default value is <code>false</code>
 	 *
 	 * @param retained whether or not the messaging engine should retain the message.

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,8 @@ public boolean isRetained() {`
`112`	`112`
`113`	`113`	`/**`
`114`	`114`	`* Whether or not the publish message should be retained by the messaging engine.`
`115`		`- * Sending a message with the retained set to <code>false</code> will clear the`
	`115`	`+ * Sending a message with retained set to <code>true</code> and with an empty`
	`116`	`+ * byte array as the payload e.g. <code>new byte[0]</code> will clear the`
`116`	`117`	`* retained message from the server. The default value is <code>false</code>`
`117`	`118`	`*`
`118`	`119`	`* @param retained whether or not the messaging engine should retain the message.`