summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrett <3911458+BrettyWhite@users.noreply.github.com>2019-10-15 10:36:59 -0400
committerGitHub <noreply@github.com>2019-10-15 10:36:59 -0400
commit2dcc9a916fb168ea37153cf6b293679267715b84 (patch)
treee41bc6d75c033baa294a7712b03316685070a115
parentfeedc0cb4eda5fd2847b133398ab143a40016731 (diff)
parentb945080e129958f3521200977d4fa674d06e8d08 (diff)
downloadsdl_android-2dcc9a916fb168ea37153cf6b293679267715b84.tar.gz
Merge pull request #1202 from smartdevicelink/update_soft_button_doc
Update SoftButtonObject javadoc
-rw-r--r--base/src/main/java/com/smartdevicelink/managers/screen/SoftButtonObject.java4
1 files changed, 2 insertions, 2 deletions
diff --git a/base/src/main/java/com/smartdevicelink/managers/screen/SoftButtonObject.java b/base/src/main/java/com/smartdevicelink/managers/screen/SoftButtonObject.java
index ec6429b4d..5bb92efc2 100644
--- a/base/src/main/java/com/smartdevicelink/managers/screen/SoftButtonObject.java
+++ b/base/src/main/java/com/smartdevicelink/managers/screen/SoftButtonObject.java
@@ -65,7 +65,7 @@ public class SoftButtonObject {
/**
* Create a new instance of the SoftButtonObject with multiple states
* @param name a String value represents name of the object
- * @param states a list of SoftButtonState represents the SoftButtonState values for the object
+ * @param states a list of SoftButtonState represents the SoftButtonState values for the object. <strong>states should be unique for every SoftButtonObject. A SoftButtonState instance cannot be reused for multiple SoftButtonObjects.</strong>
* @param initialStateName a String value represents the name for the initial state
* @param onEventListener a listener that has a callback that will be triggered when a button event happens
* Note: the initialStateName should match exactly the name of one of the states for the object. Otherwise an exception will be thrown.
@@ -235,7 +235,7 @@ public class SoftButtonObject {
/**
* Set the the SoftButtonState list
- * @param states a list of the object's soft button states
+ * @param states a list of the object's soft button states. <strong>states should be unique for every SoftButtonObject. A SoftButtonState instance cannot be reused for multiple SoftButtonObjects.</strong>
*/
public void setStates(@NonNull List<SoftButtonState> states) {
this.states = states;