Skip to content

Commit e5d8537

Browse files
noah-livionoah-livio
authored
Update Javadoc tables to match code (#1820)
1 parent c1afd4f commit e5d8537

File tree

6 files changed

+24
-31
lines changed

6 files changed

+24
-31
lines changed

‎base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@
8686
* <td>SmartDeviceLink 1.0</td>
8787
* <tr>
8888
* <td>menuParams</td>
89-
* <td>ButtonName</td>
89+
* <td>MenuParams</td>
9090
* <td>Name of the button to unsubscribe.</td>
91-
* <td>Y</td>
91+
* <td>N</td>
9292
* <td></td>
9393
* <td>SmartDeviceLink 1.0</td>
9494
* </tr>
9595
* <tr>
9696
* <td>vrCommands</td>
97-
* <td>String</td>
97+
* <td>List<String></td>
9898
* <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>
9999
* <td>N</td>
100100
* <td>minsize:1; maxsize:100</td>

‎base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
* <td>menuLayout</td>
9595
* <td>MenuLayout</td>
9696
* <td>Sets the layout of the submenu screen.</td>
97-
* <td></td>
97+
* <td>N</td>
9898
* <td></td>
9999
* <td>SmartDeviceLink 6.0</td>
100100
* </tr>

‎base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,6 @@
5555
* <th>Version</th>
5656
* </tr>
5757
* <tr>
58-
* <td>parkBrakeActive</td>
59-
* <td>Boolean</td>
60-
* <td>true</td>
61-
* <td>Describes, if the park break is active. The information about the park brake: - true, if active - false if not.</td>
62-
* <td>SmartDeviceLink 2.0</td>
63-
* </tr>
64-
* <tr>
6558
* <td>ignitionStableStatus</td>
6659
* <td>IgnitionStableStatus</td>
6760
* <td>true</td>

‎base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
* <tr>
4545
* <th>Name</th>
4646
* <th>Type</th>
47-
* <th>Description</th>
47+
* <th>Description</th>
4848
* <th>Req.</th>
4949
* <th>SmartDeviceLink Ver. Available</th>
5050
* </tr>
@@ -57,8 +57,8 @@
5757
* <li>Min: 0</li>
5858
* <li>Max: 2000000000</li>
5959
* </ul>
60-
* </td>
61-
* <th></th>
60+
* </td>
61+
* <td>N</td>
6262
* <td>SmartDeviceLink 1.0</td>
6363
* </tr>
6464
* <tr>
@@ -72,8 +72,8 @@
7272
* <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>
7373
* <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
7474
* </ul>
75-
* </td>
76-
* <th></th>
75+
* </td>
76+
* <td>N</td>
7777
* <td>SmartDeviceLink 1.0</td>
7878
* </tr>
7979
* <tr>
@@ -84,8 +84,8 @@
8484
* <li>Min: 1</li>
8585
* <li>Max: 100</li>
8686
* </ul>
87-
* </td>
88-
* <th></th>
87+
* </td>
88+
* <td>Y</td>
8989
* <td>SmartDeviceLink 1.0</td>
9090
* </tr>
9191
* <tr>

‎base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,23 +93,23 @@
9393
* </tr>
9494
* <tr>
9595
* <td>fuelLevel</td>
96-
* <td>Boolean</td>
96+
* <td>Double</td>
9797
* <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
9898
* <td>N</td>
9999
* <td>Subscribable</td>
100100
* <td>SmartDeviceLink 7.0.0</td>
101101
* </tr>
102102
* <tr>
103103
* <td>fuelLevel_State</td>
104-
* <td>Boolean</td>
104+
* <td>ComponentVolumeStatus</td>
105105
* <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
106106
* <td>N</td>
107107
* <td>Subscribable</td>
108108
* <td>SmartDeviceLink 7.0.0</td>
109109
* </tr>
110110
* <tr>
111111
* <td>fuelRange</td>
112-
* <td>Boolean</td>
112+
* <td>List<FuelRange></td>
113113
* <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
114114
* <td>N</td>
115115
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
@@ -143,15 +143,15 @@
143143
* <td>gearStatus</td>
144144
* <td>GearStatus</td>
145145
* <td>See GearStatus</td>
146-
* <td>N</td>
146+
* <td>N</td>
147147
* <td></td>
148148
* <td>SmartDeviceLink 7.0.0</td>
149149
* </tr>
150150
* <tr>
151151
* <td>prndl</td>
152152
* <td>PRNDL</td>
153153
* <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
154-
* <td>N</td>
154+
* <td>N</td>
155155
* <td></td>
156156
* <td>SmartDeviceLink 7.0.0</td>
157157
* </tr>
@@ -304,15 +304,15 @@
304304
* <td>handsOffSteering</td>
305305
* <td>Boolean</td>
306306
* <td>To indicate whether driver hands are off the steering wheel</td>
307-
* <td>N</td>
307+
* <td>N</td>
308308
* <td></td>
309309
* <td>SmartDeviceLink 7.0.0</td>
310310
* </tr>
311311
* <tr>
312312
* <td>windowStatus</td>
313-
* <td>Boolean</td>
313+
* <td>List<WindowStatus></td>
314314
* <td>See WindowStatus</td>
315-
* <td>N</td>
315+
* <td>N</td>
316316
* <td></td>
317317
* <td>SmartDeviceLink 7.0.0</td>
318318
* </tr>
@@ -330,7 +330,7 @@
330330
* <td>stabilityControlsStatus</td>
331331
* <td>StabilityControlsStatus</td>
332332
* <td>See StabilityControlsStatus</td>
333-
* <td>N</td>
333+
* <td>N</td>
334334
* <td></td>
335335
* <td>SmartDeviceLink 7.0.0</td>
336336
* </tr>

‎base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@
120120
* <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>
121121
* <td>N</td>
122122
* <td>{"string_min_length": 0, "string_max_length": 500}</td>
123-
* <td>SmartDeviceLink 1.0.0
124-
* <br>
123+
* <td>SmartDeviceLink 1.0.0
124+
* <br>
125125
* <br>
126126
* Deprecated in SmartDeviceLink 7.1.0</td>
127127
* </tr>
@@ -151,7 +151,7 @@
151151
* </tr>
152152
* <tr>
153153
* <td>softButtons</td>
154-
* <td>SoftButton</td>
154+
* <td>List<SoftButton></td>
155155
* <td>Soft buttons as defined by the App</td>
156156
* <td>N</td>
157157
* <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 @@
168168
* <tr>
169169
* <td>templateTitle</td>
170170
* <td>String</td>
171-
* <td>The title of the new template that will be displayed.</td>
171+
* <td>The title of the new template that will be displayed.</td>
172172
* <td>N</td>
173173
* <td><p>How this will be displayed is dependent on the OEM design and implementation of the template..</p>Minsize: 0; Maxsize: 100</td>
174174
* <td>SmartDeviceLink 6.0.0</td>

0 commit comments

Comments
 (0)