summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornoah-livio <95378272+noah-livio@users.noreply.github.com>2022-07-13 16:06:59 -0400
committerGitHub <noreply@github.com>2022-07-13 16:06:59 -0400
commite5d85378c522f48c720f85546ab13bab3ac30ecd (patch)
tree481b2630cd6b1d718ac7fd99eec5df2d0d547219
parentc1afd4f7d4af7cd6783d2c019b877153f84a6745 (diff)
downloadsdl_android-e5d85378c522f48c720f85546ab13bab3ac30ecd.tar.gz
Update Javadoc tables to match code (#1820)
Diffstat
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java6
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java2
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java7
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java14
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java18
-rw-r--r--base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java8
6 files changed, 24 insertions, 31 deletions
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java
index e46d39339..0e00a14aa 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java
@@ -86,15 +86,15 @@ import java.util.List;
* <td>SmartDeviceLink 1.0</td>
* <tr>
* <td>menuParams</td>
- * <td>ButtonName</td>
+ * <td>MenuParams</td>
* <td>Name of the button to unsubscribe.</td>
- * <td>Y</td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>vrCommands</td>
- * <td>String</td>
+ * <td>List<String></td>
* <td><p>An array of strings to be used as VR synonyms for this command.</p> <p>If this array is provided, it may not be empty.</p></td>
* <td>N</td>
* <td>minsize:1; maxsize:100</td>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
index fcd93d42e..6be1f4c03 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
@@ -94,7 +94,7 @@ import java.util.Hashtable;
* <td>menuLayout</td>
* <td>MenuLayout</td>
* <td>Sets the layout of the submenu screen.</td>
- * <td></td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 6.0</td>
* </tr>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java
index 08819aa09..8d016c15d 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java
@@ -55,13 +55,6 @@ import java.util.List;
* <th>Version</th>
* </tr>
* <tr>
- * <td>parkBrakeActive</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>Describes, if the park break is active. The information about the park brake: - true, if active - false if not.</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
* <td>ignitionStableStatus</td>
* <td>IgnitionStableStatus</td>
* <td>true</td>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java
index 2f6b3d712..d62ef079d 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java
@@ -44,7 +44,7 @@ import java.util.Hashtable;
* <tr>
* <th>Name</th>
* <th>Type</th>
- * <th>Description</th>
+ * <th>Description</th>
* <th>Req.</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
@@ -57,8 +57,8 @@ import java.util.Hashtable;
* <li>Min: 0</li>
* <li>Max: 2000000000</li>
* </ul>
- * </td>
- * <th></th>
+ * </td>
+ * <td>N</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -72,8 +72,8 @@ import java.util.Hashtable;
* <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
* <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
* </ul>
- * </td>
- * <th></th>
+ * </td>
+ * <td>N</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -84,8 +84,8 @@ import java.util.Hashtable;
* <li>Min: 1</li>
* <li>Max: 100</li>
* </ul>
- * </td>
- * <th></th>
+ * </td>
+ * <td>Y</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java
index 09608fb9a..800141ace 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java
@@ -93,7 +93,7 @@ import java.util.List;
* </tr>
* <tr>
* <td>fuelLevel</td>
- * <td>Boolean</td>
+ * <td>Double</td>
* <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
@@ -101,7 +101,7 @@ import java.util.List;
* </tr>
* <tr>
* <td>fuelLevel_State</td>
- * <td>Boolean</td>
+ * <td>ComponentVolumeStatus</td>
* <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
@@ -109,7 +109,7 @@ import java.util.List;
* </tr>
* <tr>
* <td>fuelRange</td>
- * <td>Boolean</td>
+ * <td>List<FuelRange></td>
* <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
* <td>N</td>
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
@@ -143,7 +143,7 @@ import java.util.List;
* <td>gearStatus</td>
* <td>GearStatus</td>
* <td>See GearStatus</td>
- * <td>N</td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
@@ -151,7 +151,7 @@ import java.util.List;
* <td>prndl</td>
* <td>PRNDL</td>
* <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
- * <td>N</td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
@@ -304,15 +304,15 @@ import java.util.List;
* <td>handsOffSteering</td>
* <td>Boolean</td>
* <td>To indicate whether driver hands are off the steering wheel</td>
- * <td>N</td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
* <tr>
* <td>windowStatus</td>
- * <td>Boolean</td>
+ * <td>List<WindowStatus></td>
* <td>See WindowStatus</td>
- * <td>N</td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
@@ -330,7 +330,7 @@ import java.util.List;
* <td>stabilityControlsStatus</td>
* <td>StabilityControlsStatus</td>
* <td>See StabilityControlsStatus</td>
- * <td>N</td>
+ * <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java
index 1e091beb6..2eaa41e56 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java
@@ -120,8 +120,8 @@ import java.util.List;
* <td>Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.</td>
* <td>N</td>
* <td>{"string_min_length": 0, "string_max_length": 500}</td>
- * <td>SmartDeviceLink 1.0.0
- * <br>
+ * <td>SmartDeviceLink 1.0.0
+ * <br>
* <br>
* Deprecated in SmartDeviceLink 7.1.0</td>
* </tr>
@@ -151,7 +151,7 @@ import java.util.List;
* </tr>
* <tr>
* <td>softButtons</td>
- * <td>SoftButton</td>
+ * <td>List<SoftButton></td>
* <td>Soft buttons as defined by the App</td>
* <td>N</td>
* <td><p>If omitted on supported displays, the currently displayed SoftButton values will not change.</p>Array Minsize: 0; Array Maxsize: 8</td>
@@ -168,7 +168,7 @@ import java.util.List;
* <tr>
* <td>templateTitle</td>
* <td>String</td>
- * <td>The title of the new template that will be displayed.</td>
+ * <td>The title of the new template that will be displayed.</td>
* <td>N</td>
* <td><p>How this will be displayed is dependent on the OEM design and implementation of the template..</p>Minsize: 0; Maxsize: 100</td>
* <td>SmartDeviceLink 6.0.0</td>
View Lorry Controller Status