Skip to content

Commit 94335cd

Browse files
committed
Adding Documentation fixes for ExecutorService addition
Signed-off-by: James Sutton <james.sutton@uk.ibm.com>
1 parent dd7970d commit 94335cd

6 files changed

Lines changed: 7 additions & 3 deletions

File tree

org.eclipse.paho.client.mqttv3/src/main/java-templates/org/eclipse/paho/client/mqttv3/internal/ClientComms.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ public class ClientComms {
9191
* @param client The {@link IMqttAsyncClient}
9292
* @param persistence the {@link MqttClientPersistence} layer.
9393
* @param pingSender the {@link MqttPingSender}
94+
* @param executorService the {@link ExecutorService}
9495
* @throws MqttException if an exception occurs whilst communicating with the server
9596
*/
9697
public ClientComms(IMqttAsyncClient client, MqttClientPersistence persistence, MqttPingSender pingSender, ExecutorService executorService) throws MqttException {

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,11 +250,12 @@ public MqttClient(String serverURI, String clientId, MqttClientPersistence persi
250250
* connection are supported <code>tcp://</code> for a TCP connection and
251251
* <code>ssl://</code> for a TCP connection secured by SSL/TLS.
252252
* For example:
253+
* </p>
253254
* <ul>
254255
* <li><code>tcp://localhost:1883</code></li>
255256
* <li><code>ssl://localhost:8883</code></li>
256257
* </ul>
257-
* If the port is not specified, it will
258+
* <p>If the port is not specified, it will
258259
* default to 1883 for <code>tcp://</code>" URIs, and 8883 for <code>ssl://</code> URIs.
259260
* </p>
260261
*

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttConnectOptions.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,7 @@ public HostnameVerifier getSSLHostnameVerifier() {
425425
* <p>
426426
* There is no default HostnameVerifier
427427
* </p>
428+
* @param hostnameVerifier the {@link HostnameVerifier}
428429
*/
429430
public void setSSLHostnameVerifier(HostnameVerifier hostnameVerifier) {
430431
this.sslHostnameVerifier = hostnameVerifier;

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/CommsCallback.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ public void setClientState(ClientState clientState) {
8181
/**
8282
* Starts up the Callback thread.
8383
* @param threadName The name of the thread
84+
* @param executorService the {@link ExecutorService}
8485
*/
8586
public void start(String threadName, ExecutorService executorService) {
8687
this.threadName = threadName;

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/CommsReceiver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public CommsReceiver(ClientComms clientComms, ClientState clientState,CommsToken
6060

6161
/**
6262
* Starts up the Receiver's thread.
63-
* @param threadName
63+
* @param threadName the thread name.
6464
* @param executorService used to execute the thread
6565
*/
6666
public void start(String threadName, ExecutorService executorService) {

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/CommsSender.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public CommsSender(ClientComms clientComms, ClientState clientState, CommsTokenS
5757

5858
/**
5959
* Starts up the Sender thread.
60-
* @param threadName
60+
* @param threadName the threadname
6161
* @param executorService used to execute the thread
6262
*/
6363
public void start(String threadName, ExecutorService executorService) {

0 commit comments

Comments
 (0)