summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBretty White <geekman3454@protonmail.com>2018-05-30 11:40:08 -0400
committerBretty White <geekman3454@protonmail.com>2018-05-30 11:40:08 -0400
commit0128047a509c18a53942a5531f08072486a93227 (patch)
treec297003dcd082c4e9bd0c5dcc6fa226704687cf1
parent18c6f8c0181576a946bb5714261369914476090f (diff)
downloadsdl_android-feature/issue_154.tar.gz
missed a few docsfeature/issue_154
-rw-r--r--sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java15
-rw-r--r--sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java13
-rw-r--r--sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java9
3 files changed, 12 insertions, 25 deletions
diff --git a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
index 1413c5ee6..b61a28772 100644
--- a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
+++ b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
@@ -77,20 +77,16 @@ public class AddSubMenu extends RPCRequest {
* Constructs a new AddSubMenu object indicated by the Hashtable parameter
*
*
- * @param hash
- * The Hashtable to use
+ * @param hash The Hashtable to use
*/
public AddSubMenu(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a new AddSubMenu object
- * @param menuID
- * an integer object representing a Menu ID
- *
- * <p><b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
- * @param menuName
- * String which will be displayed representing this submenu item
+ * @param menuID an integer object representing a Menu ID
+ * <p><b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
+ * @param menuName String which will be displayed representing this submenu item
*/
public AddSubMenu(@NonNull Integer menuID, @NonNull String menuName) {
this();
@@ -100,8 +96,7 @@ public class AddSubMenu extends RPCRequest {
/**
* Returns an <i>Integer</i> object representing the Menu ID that identifies
* a sub menu
- *
- *
+ *
* @return Integer -an integer representing the Menu ID that identifies a sub
* menu
*/
diff --git a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java
index 1fa80eadf..94fb75083 100644
--- a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java
+++ b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java
@@ -29,9 +29,7 @@ public class ButtonPress extends RPCRequest {
* <p>Constructs a new ButtonPress object indicated by the
* Hashtable parameter</p>
*
- *
- * @param hash
- * The Hashtable to use
+ * @param hash The Hashtable to use
*/
public ButtonPress(Hashtable<String, Object> hash) {
super(hash);
@@ -39,12 +37,9 @@ public class ButtonPress extends RPCRequest {
/**
* Constructs a new ButtonPress object
- * @param moduleType
- * Represents module where the button should be pressed
- * @param buttonName
- * Represents name of supported RC climate or radio button
- * @param buttonPressMode
- * Indicates whether this is a LONG or SHORT button press event.
+ * @param moduleType Represents module where the button should be pressed
+ * @param buttonName Represents name of supported RC climate or radio button
+ * @param buttonPressMode Indicates whether this is a LONG or SHORT button press event.
*/
public ButtonPress(@NonNull ModuleType moduleType, @NonNull ButtonName buttonName, @NonNull ButtonPressMode buttonPressMode) {
this();
diff --git a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java
index eff6163ec..61a967585 100644
--- a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java
+++ b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java
@@ -35,9 +35,8 @@ public class ClimateControlCapabilities extends RPCStruct{
/**
* Constructs a newly allocated ClimateControlCapabilities
- * @param moduleName
- * The short friendly name of the climate control module.
- * It should not be used to identify a module by mobile application.
+ *
+ * @param moduleName The short friendly name of the climate control module. It should not be used to identify a module by mobile application.
*/
public ClimateControlCapabilities(@NonNull String moduleName) {
this();
@@ -47,9 +46,7 @@ public class ClimateControlCapabilities extends RPCStruct{
/**
* Sets the moduleName portion of the ClimateControlCapabilities class
*
- * @param moduleName
- * The short friendly name of the climate control module.
- * It should not be used to identify a module by mobile application.
+ * @param moduleName The short friendly name of the climate control module. It should not be used to identify a module by mobile application.
*/
public void setModuleName(@NonNull String moduleName) {
setValue(KEY_MODULE_NAME, moduleName);