Skip to content

Commit cae4a55

Browse files
committed
Fix Javadoc errors
1 parent 5328c13 commit cae4a55

File tree

4 files changed

+19
-26
lines changed

4 files changed

+19
-26
lines changed

jsmpp/src/main/java/org/jsmpp/SMPPConstant.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -199,49 +199,49 @@ public interface SMPPConstant {
199199
public static final byte ESMCLS_ESME_MANUAL_ACK = 0x10;
200200

201201
/**
202-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
202+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
203203
* xx0001xx Short Message contains SMSC Delivery Receipt.
204204
*/
205205
public static final byte ESMCLS_SMSC_DELIV_RECEIPT = 0x04;
206206

207207
/**
208-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
208+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
209209
* xx0001xx Short Message contains SME Delivery Acknowledgment.
210210
*/
211211
public static final byte ESMCLS_SME_DELIV_ACK = 0x08;
212212

213213
/**
214-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
214+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
215215
* xx0100xx Short Message contains SME Manual/User Acknowledgment.
216216
*/
217217
public static final byte ESMCLS_SME_MANUAL_ACK = 0x10;
218218

219219
/**
220-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
220+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
221221
* xx0110xx Short Message contains Conversation Abort (Korean CDMA).
222222
*/
223223
public static final byte ESMCLS_CONV_ABORT = 0x18;
224224

225225
/**
226-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
226+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
227227
* xx1000xx Short Message contains Intermediate Delivery Notification.
228228
*/
229229
public static final byte ESMCLS_INTRMD_DELIV_NOTIF = 0x20;
230230

231231
/**
232-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
232+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
233233
* 01xxxxxx UDHI Indicator set.
234234
*/
235235
public static final byte ESMCLS_UDHI_INDICATOR_SET = 0x40;
236236

237237
/**
238-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
238+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
239239
* 10xxxxxx Reply Path.
240240
*/
241241
public static final byte ESMCLS_REPLY_PATH = (byte)0x80;
242242

243243
/**
244-
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)<br/>
244+
* Encoded esm_class parameter for deliver_sm or data_sm (SMSC -> ESME)
245245
* 11xxxxxx UDHI and Reply Path can use.
246246
*/
247247
public static final byte ESMCLS_UDHI_REPLY_PATH = (byte)0xc0;

jsmpp/src/main/java/org/jsmpp/bean/AbstractSmCommand.java

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public AbstractSmCommand() {
4545
/**
4646
* Message Type.
4747
*
48-
* @return
48+
* @return if the esmClass is the default message type (00)
4949
*/
5050
public boolean isDefaultMessageType() {
5151
return isDefaultMessageType(esmClass);
@@ -61,7 +61,7 @@ public void setDefaultMessageType() {
6161
/**
6262
* Specific Features.
6363
*
64-
* @return
64+
* @return if the esmClass contains the User Data Header Indicator
6565
*/
6666
public boolean isUdhi() {
6767
return isUdhi(esmClass);
@@ -289,7 +289,7 @@ public static boolean isReplyPath(byte esmClass) {
289289
* Specific Features.
290290
*
291291
* @param esmClass
292-
* @return
292+
* @return the esmClass with Reply Path
293293
*/
294294
public static byte composeReplyPath(byte esmClass) {
295295
return composeSpecificFeatures(esmClass, SMPPConstant.ESMCLS_REPLY_PATH);
@@ -299,7 +299,7 @@ public static byte composeReplyPath(byte esmClass) {
299299
* Specific Features.
300300
*
301301
* @param esmClass
302-
* @return
302+
* @return if the esmClass has User Data Header Indicator and Reply Path
303303
*/
304304
public static boolean isUdhiAndReplyPath(byte esmClass) {
305305
return isSpecificFeatures(esmClass, SMPPConstant.ESMCLS_UDHI_REPLY_PATH);
@@ -309,7 +309,7 @@ public static boolean isUdhiAndReplyPath(byte esmClass) {
309309
* Specific Features.
310310
*
311311
* @param esmClass
312-
* @return
312+
* @return the esmClass with User Data Header Indicator and Reply Path
313313
*/
314314
public static byte composeUdhiAndReplyPath(byte esmClass) {
315315
return composeSpecificFeatures(esmClass,
@@ -342,7 +342,7 @@ protected final static byte composeMessagingMode(byte esmClass,
342342
* Clean the Messaging Mode or clean the ESM Class at bits 1 - 0.
343343
*
344344
* @param esmClass
345-
* @return
345+
* @return the esmClass without the Messaging Mode bits
346346
*/
347347
protected final static byte cleanMessagingMode(byte esmClass) {
348348
/*
@@ -453,20 +453,17 @@ protected static final byte cleanSmscDeliveryReceipt(byte registeredDelivery) {
453453
return (byte)(registeredDelivery & 0x0fc);
454454
}
455455

456-
/*
457-
* SME originated Acknowledgement.
458-
*/
459456
/**
460457
* SME originated Acknowledgement.
461458
*
462-
* @param registeredDeliery
459+
* @param registeredDelivery
463460
* @param smeOriginatedAckValue
464461
* @return
465462
*/
466-
protected static final boolean isSmeAck(byte registeredDeliery,
463+
protected static final boolean isSmeAck(byte registeredDelivery,
467464
byte smeOriginatedAckValue) {
468465
// xxxx11xx = 0x0c mask bits 3 - 2
469-
return (registeredDeliery & 0x0c) == smeOriginatedAckValue;
466+
return (registeredDelivery & 0x0c) == smeOriginatedAckValue;
470467
}
471468

472469
protected static final byte composeSmeAck(byte registeredDelivery,

jsmpp/src/main/java/org/jsmpp/bean/DataCodingFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222
public interface DataCodingFactory {
2323

2424
/**
25-
* @param dataCoding
25+
* @param dataCoding The data coding scheme
2626
* @return <tt>true</tt> if dataCoding is recognized
2727
*/
2828
boolean isRecognized(byte dataCoding);
2929

3030
/**
31-
* @param dataCoding
31+
* @param dataCoding The data coding scheme
3232
* @return new DataCoding object
3333
*/
3434
DataCoding newInstance(byte dataCoding);

jsmpp/src/main/java/org/jsmpp/session/AbstractSession.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -312,11 +312,7 @@ protected Command executeSendCommand(SendCommandTask task, long timeout)
312312
* Execute send command command task.
313313
*
314314
* @param task is the task.
315-
* @return the command response.
316315
* @throws PDUException if there is invalid PDU parameter found.
317-
* @throws ResponseTimeoutException if the response has reach it timeout.
318-
* @throws InvalidResponseException if invalid response found.
319-
* @throws NegativeResponseException if the negative response found.
320316
* @throws IOException if there is an IO error found.
321317
*/
322318
protected void executeSendCommandWithNoResponse(SendCommandTask task)

0 commit comments

Comments
 (0)