Skip to content

Commit

Permalink
Update Javadoc tables to match code (#1820)
Browse files Browse the repository at this point in the history
  • Loading branch information
@noah-livio
noah-livio authored Jul 13, 2022
1 parent c1afd4f commit e5d8537
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 31 deletions.
6 changes: 3 additions & 3 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@
* <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>
Expand Down
2 changes: 1 addition & 1 deletion base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
* <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>
Expand Down
7 changes: 0 additions & 7 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,6 @@
* <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>
Expand Down
14 changes: 7 additions & 7 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>Description</th>
* <th>Req.</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
Expand All @@ -57,8 +57,8 @@
* <li>Min: 0</li>
* <li>Max: 2000000000</li>
* </ul>
* </td>
* <th></th>
* </td>
* <td>N</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
Expand All @@ -72,8 +72,8 @@
* <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>
Expand All @@ -84,8 +84,8 @@
* <li>Min: 1</li>
* <li>Max: 100</li>
* </ul>
* </td>
* <th></th>
* </td>
* <td>Y</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
Expand Down
18 changes: 9 additions & 9 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,23 +93,23 @@
* </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>
* <td>SmartDeviceLink 7.0.0</td>
* </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>
* <td>SmartDeviceLink 7.0.0</td>
* </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>
Expand Down Expand Up @@ -143,15 +143,15 @@
* <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>
* <tr>
* <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>
Expand Down Expand Up @@ -304,15 +304,15 @@
* <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>
Expand All @@ -330,7 +330,7 @@
* <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>
Expand Down
8 changes: 4 additions & 4 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@
* <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>
Expand Down Expand Up @@ -151,7 +151,7 @@
* </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>
Expand All @@ -168,7 +168,7 @@
* <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>
Expand Down

0 comments on commit e5d8537

Please sign in to comment.