Skip to content

Commit 831a69d

Browse files
author
Ian Craggs
committed
Javadoc corrections
1 parent 6655ca2 commit 831a69d

5 files changed

Lines changed: 11 additions & 6 deletions

File tree

org.eclipse.paho.mqttv5.client/src/main/java/org/eclipse/paho/mqttv5/client/IMqttClient.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ public interface IMqttClient { //extends IMqttAsyncClient {
191191
* published at a lower quality of service will be received at the published
192192
* QoS. Messages published at a higher quality of service will be received using
193193
* the QoS specified on the subscribe.
194+
* @return a token
194195
* @throws MqttException if there was an error registering the subscription.
195196
*/
196197
public IMqttToken subscribe(String topicFilter, int qos) throws MqttException;
@@ -288,6 +289,7 @@ public interface IMqttClient { //extends IMqttAsyncClient {
288289
* published at a lower quality of service will be received at the published
289290
* QoS. Messages published at a higher quality of service will be received using
290291
* the QoS specified on the subscribe.
292+
* @return a token
291293
* @throws MqttException if there was an error registering the subscription.
292294
* @throws IllegalArgumentException if the two supplied arrays are not the same size.
293295
*/
@@ -298,8 +300,10 @@ public interface IMqttClient { //extends IMqttAsyncClient {
298300
*
299301
* @see #subscribe(String[], int[])
300302
*
301-
* @param topicFilters the topic to subscribe to, which can include wildcards.
303+
* @param topicFilter the topic to subscribe to, which can include wildcards.
304+
* @param qos QoS
302305
* @param messageListener one callbacks to handle incoming messages
306+
* @return a token
303307
* @throws MqttException if there was an error registering the subscription.
304308
*/
305309
public IMqttToken subscribe(String topicFilter, int qos, IMqttMessageListener messageListener) throws MqttException;
@@ -396,6 +400,7 @@ public interface IMqttClient { //extends IMqttAsyncClient {
396400
* QoS. Messages published at a higher quality of service will be received using
397401
* the QoS specified on the subscribe.
398402
* @param messageListeners one or more callbacks to handle incoming messages
403+
* @return a token
399404
* @throws MqttException if there was an error registering the subscription.
400405
* @throws IllegalArgumentException if the two supplied arrays are not the same size.
401406
*/

org.eclipse.paho.mqttv5.client/src/main/java/org/eclipse/paho/mqttv5/client/MqttClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ public class MqttClient implements IMqttClient {
150150
* An instance of the default persistence mechanism
151151
* {@link MqttDefaultFilePersistence} is used by the client. To specify a
152152
* different persistence mechanism or to turn off persistence, use the
153-
* {@link #MqttLegacyBlockingClient(String, String, MqttClientPersistence)}
153+
* {@link #MqttClient(String, String, MqttClientPersistence)}
154154
* constructor.
155155
*
156156
* @param serverURI

org.eclipse.paho.mqttv5.client/src/main/java/org/eclipse/paho/mqttv5/client/MqttClientPersistence.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* Represents a persistent data store, used to store outbound and inbound messages while they
2525
* are in flight, enabling delivery to the QoS specified. You can specify an implementation
26-
* of this interface using {@link MqttClient#MqttLegacyBlockingClient(String, String, MqttClientPersistence)},
26+
* of this interface using {@link MqttClient#MqttClient(String, String, MqttClientPersistence)},
2727
* which the {@link MqttClient} will use to persist QoS 1 and 2 messages.
2828
* <p>
2929
* If the methods defined throw the MqttPersistenceException then the state of the data persisted

org.eclipse.paho.mqttv5.client/src/main/java/org/eclipse/paho/mqttv5/client/alpha/MqttClientPersistence.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
/**
2323
* Represents a persistent data store, used to store outbound and inbound messages while they
2424
* are in flight, enabling delivery to the QoS specified. You can specify an implementation
25-
* of this interface using {@link MqttLegacyBlockingClient#MqttLegacyBlockingClient(String, String)},
26-
* which the {@link MqttLegacyBlockingClient} will use to persist QoS 1 and 2 messages.
25+
* of this interface using {@link MqttClient#MqttClient(String, String)},
26+
* which the {@link MqttClient} will use to persist QoS 1 and 2 messages.
2727
* <p>
2828
* If the methods defined throw the MqttPersistenceException then the state of the data persisted
2929
* should remain as prior to the method being called. For example, if {@link #put(String, MqttPersistable)}

org.eclipse.paho.mqttv5.client/src/main/java/org/eclipse/paho/mqttv5/client/internal/ClientComms.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public class ClientComms {
9191
* network calls.
9292
*
9393
* @param client
94-
* The {@link IMqttAsyncClient}
94+
* The {@link MqttClientInterface}
9595
* @param persistence
9696
* the {@link MqttClientPersistence} layer.
9797
* @param pingSender

0 commit comments

Comments
 (0)