Skip to content

Add timeout units to Javadoc comments #1778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bilal-alsharifi merged 2 commits into from
Jan 6, 2022
Merged

Add timeout units to Javadoc comments #1778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90f84ef
Add timeout units to Javadoc comments
noah-livio Dec 16, 2021
ab50c0e
Add time units to Slider class
noah-livio Jan 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
* <tr>
* <td>timeout</td>
* <td>Integer</td>
* <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</td>
* <td>App defined timeout. Indicates how long of a timeout in milliseconds from the last action (i.e. scrolling message resets timeout).</td>
* <td>N</td>
* <td>minValue=1000; maxValue=65535; defValue=30000</td>
* <td>SmartDevice Link 1.0 </td>
Expand Down Expand Up @@ -166,10 +166,10 @@ public String getScrollableMessageBody() {
}

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

/**
* Gets an App defined timeout
* Gets an App defined timeout in milliseconds
*
* @return Integer -an Integer value representing an App defined timeout
* @return Integer -an Integer value representing an App defined timeout in milliseconds
*/
public Integer getTimeout() {
return getInteger(KEY_TIMEOUT);
Expand Down
10 changes: 5 additions & 5 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
* <tr>
* <td>timeout</td>
* <td>String</td>
* <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>
* <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>
* <td>N</td>
* <td>Minvalue=0; Maxvalue=65535; Defvalue= 10000</td>
* <td>SmartDeviceLink 2.0</td>
Expand Down Expand Up @@ -255,9 +255,9 @@ public List<String> getSliderFooter() {
}

/**
* Sets an App defined timeout
* Sets an App defined timeout in milliseconds
*
* @param timeout an Integer value representing an App defined timeout
* @param timeout an Integer value representing an App defined timeout in milliseconds
* <p></p>
* <b>Notes: </b>Minvalue=0; Maxvalue=65535; Defvalue=10000
*/
Expand All @@ -267,9 +267,9 @@ public Slider setTimeout(Integer timeout) {
}

/**
* Gets an App defined timeout
* Gets an App defined timeout in milliseconds
*
* @return Integer -an Integer value representing an App defined timeout
* @return Integer -an Integer value representing an App defined timeout in milliseconds
*/
public Integer getTimeout() {
return getInteger(KEY_TIMEOUT);
Expand Down