Skip to content

Commit 039503d

Browse files
Merge pull request #1778 from noah-livio/bugfix/issue_1775
Add timeout units to Javadoc comments
2 parents b2b1e59 + ab50c0e commit 039503d

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
* <tr>
7171
* <td>timeout</td>
7272
* <td>Integer</td>
73-
* <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</td>
73+
* <td>App defined timeout. Indicates how long of a timeout in milliseconds from the last action (i.e. scrolling message resets timeout).</td>
7474
* <td>N</td>
7575
* <td>minValue=1000; maxValue=65535; defValue=30000</td>
7676
* <td>SmartDevice Link 1.0 </td>
@@ -166,10 +166,10 @@ public String getScrollableMessageBody() {
166166
}
167167

168168
/**
169-
* Sets an App defined timeout. Indicates how long of a timeout from the
169+
* Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the
170170
* last action
171171
*
172-
* @param timeout an Integer value representing an App defined timeout
172+
* @param timeout an Integer value representing an App defined timeout in milliseconds
173173
* <p></p>
174174
* <b>Notes</b>:Minval=0; Maxval=65535;Default=30000
175175
*/
@@ -179,9 +179,9 @@ public ScrollableMessage setTimeout(Integer timeout) {
179179
}
180180

181181
/**
182-
* Gets an App defined timeout
182+
* Gets an App defined timeout in milliseconds
183183
*
184-
* @return Integer -an Integer value representing an App defined timeout
184+
* @return Integer -an Integer value representing an App defined timeout in milliseconds
185185
*/
186186
public Integer getTimeout() {
187187
return getInteger(KEY_TIMEOUT);

base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
* <tr>
9696
* <td>timeout</td>
9797
* <td>String</td>
98-
* <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.</td>
98+
* <td>App defined timeout. Indicates how long of a timeout in milliseconds from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.</td>
9999
* <td>N</td>
100100
* <td>Minvalue=0; Maxvalue=65535; Defvalue= 10000</td>
101101
* <td>SmartDeviceLink 2.0</td>
@@ -255,9 +255,9 @@ public List<String> getSliderFooter() {
255255
}
256256

257257
/**
258-
* Sets an App defined timeout
258+
* Sets an App defined timeout in milliseconds
259259
*
260-
* @param timeout an Integer value representing an App defined timeout
260+
* @param timeout an Integer value representing an App defined timeout in milliseconds
261261
* <p></p>
262262
* <b>Notes: </b>Minvalue=0; Maxvalue=65535; Defvalue=10000
263263
*/
@@ -267,9 +267,9 @@ public Slider setTimeout(Integer timeout) {
267267
}
268268

269269
/**
270-
* Gets an App defined timeout
270+
* Gets an App defined timeout in milliseconds
271271
*
272-
* @return Integer -an Integer value representing an App defined timeout
272+
* @return Integer -an Integer value representing an App defined timeout in milliseconds
273273
*/
274274
public Integer getTimeout() {
275275
return getInteger(KEY_TIMEOUT);

0 commit comments

Comments
 (0)