Skip to content

Fix formatting of many tables within the documentation #1810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
noah-livio merged 18 commits into from
Jun 28, 2022
Merged

Fix formatting of many tables within the documentation #1810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
a13e1c1
Fix Table Format
jordynmackool Apr 21, 2022
63bf14e
Update show
jordynmackool Apr 21, 2022
d976431
Update GetVehicleData.java
jordynmackool Apr 21, 2022
c962585
Update GetVehicleData.java
jordynmackool Apr 21, 2022
52448a1
Update GetVehicleData.java
jordynmackool Apr 21, 2022
357a8f0
Update GetVehicleData.java
jordynmackool Apr 21, 2022
a72afb1
Update GetVehicleData.java
jordynmackool Apr 21, 2022
ee3af0e
Update MenuParams.java
jordynmackool Apr 21, 2022
d8c745a
Update MenuParams.java
jordynmackool Apr 21, 2022
846d95c
Update BodyInformation.java
jordynmackool Apr 21, 2022
9620f77
Update OnVehicleData.java
jordynmackool Apr 25, 2022
5550702
Updates
jordynmackool Jun 22, 2022
17ea7d3
Update spacing
jordynmackool Jun 23, 2022
309f01c
Update base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
jordynmackool Jun 28, 2022
90bab6a
Update base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformati…
jordynmackool Jun 28, 2022
f050659
Update base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformati…
jordynmackool Jun 28, 2022
520e384
Update base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformati…
jordynmackool Jun 28, 2022
d6553ff
Update base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformati…
jordynmackool Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,7 @@
* <td>Optional secondary image struct for menu cell</td>
* <td>N</td>
* <td></td>
* <td>
* @since SmartDeviceLink 7.1.0
* </td>
* <td>SmartDeviceLink 7.1.0</td>
* </tr>
* </table>
* <p> <b>Response</b></p><p>Indicates that the corresponding request has failed or succeeded, if the response returns with a SUCCESS result code, this means a command was added to the Command Menu successfully.</p>
Expand Down
12 changes: 3 additions & 9 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,29 +112,23 @@
* <td>Optional secondary text to display</td>
* <td>N</td>
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* </td>
* <td>SmartDeviceLink 7.1.0</td>
* </tr>
* <tr>
* <td>tertiaryText</td>
* <td>String</td>
* <td>Optional tertiary text to display</td>
* <td>N</td>
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* </td>
* <td>SmartDeviceLink 7.1.0</td>
* </tr>
* <tr>
* <td>secondaryImage</td>
* <td>Image</td>
* <td>Optional secondary image struct for sub-menu cell</td>
* <td>N</td>
* <td></td>
* <td>
* @since SmartDeviceLink 7.1.0
* </td>
* <td>SmartDeviceLink 7.1.0</td>
* </tr>
* </table>
* <b>Response</b>
Expand Down
56 changes: 32 additions & 24 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,71 +85,79 @@
* <tr>
* <td>driverDoorAjar</td>
* <td>Boolean</td>
* <td>true</td>
* <td>false</td>
* <td>The information about the park brake: - true, if active - false if not.</td>
* <td>
* @since SmartDeviceLink 2.0.0
* @property-deprecated in SmartDeviceLink 7.1.0
* SmartDeviceLink 2.0.0
* <br>
* <br>
* Deprecated in SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>passengerDoorAjar</td>
* <td>Boolean</td>
* <td>true</td>
* <td>false</td>
* <td>The information about the park brake: - true, if active - false if not.</td>
* <td>
* @since SmartDeviceLink 2.0.0
* @property-deprecated in SmartDeviceLink 7.1.0
* SmartDeviceLink 2.0.0
* <br>
* <br>
* Deprecated in SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>rearLeftDoorAjar</td>
* <td>Boolean</td>
* <td>true</td>
* <td>false</td>
* <td>The information about the park brake: - true, if active - false if not.</td>
* <td>
* @since SmartDeviceLink 2.0.0
* @property-deprecated in SmartDeviceLink 7.1.0
* SmartDeviceLink 2.0.0
* <br>
* <br>
* Deprecated in SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>rearRightDoorAjar</td>
* <td>Boolean</td>
* <td>true</td>
* <td>false</td>
* <td>References signal "DrStatRr_B_Actl".</td>
* <td>
* @since SmartDeviceLink 2.0.0
* @property-deprecated in SmartDeviceLink 7.1.0
* SmartDeviceLink 2.0.0
* <br>
* <br>
* Deprecated in SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>doorStatuses</td>
* <td>List<DoorStatus></td>
* <td>Provides status for doors if Ajar/Closed/Locked</td>
* <td>N</td>
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
* <td>False</td>
* <td>Provides status for doors if Ajar/Closed/Locked
* {"array_min_size": 0, "array_max_size": 100}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>gateStatuses</td>
* <td>List<GateStatus></td>
* <td>Provides status for trunk/hood/etc. if Ajar/Closed/Locked</td>
* <td>N</td>
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
* <td>False</td>
* <td>Provides status for trunk/hood/etc. if Ajar/Closed/Locked
* {"array_min_size": 0, "array_max_size": 100}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>roofStatuses</td>
* <td>List<RoofStatus></td>
* <td>Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.</td>
* <td>N</td>
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
* <td>False</td>
* <td>Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/ Removedetc.
* {"array_min_size": 0, "array_max_size": 100}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* </table>
Expand Down
26 changes: 16 additions & 10 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,10 @@
* <td>N</td>
* <td>Subscribable</td>
* <td>
* @since SmartDeviceLink 2.0.0
* @property-deprecated in SmartDeviceLink 7.1.0
* SmartDeviceLink 2.0.0
* <br>
* <br>
* Deprecated in SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
Expand All @@ -124,19 +126,20 @@
* <td>Subscribable</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <tr>
* <td>gearStatus</td>
* <td>Boolean</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>Boolean</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>
* <tr>
Expand Down Expand Up @@ -254,22 +257,25 @@
* <td>stabilityControlsStatus</td>
* <td>Boolean</td>
* <td>See StabilityControlsStatus</td>
* <td>N</td>
* <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
* </tr>
* <tr>
* <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>See WindowStatus</td>
* <td>N</td>
* <td>N</td>
* <td></td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
* <tr>
Expand All @@ -279,7 +285,7 @@
* <td>N</td>
* <td></td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
Expand All @@ -289,7 +295,7 @@
* <td>N</td>
* <td></td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* </table>
Expand Down
10 changes: 5 additions & 5 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
* <td>KeyboardInputMask</td>
* <td>false</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* <td>Allows an app to mask entered characters on HMI</td>
* </tr>
Expand All @@ -116,7 +116,7 @@
* <td>List<String></td>
* <td>false</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* <td>
* Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters
Expand Down Expand Up @@ -245,7 +245,7 @@ public KeyboardProperties setAutoCompleteList(List<String> autoCompleteList) {
* Sets the maskInputCharacters.
*
* @param maskInputCharacters Allows an app to mask entered characters on HMI
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
*/
public KeyboardProperties setMaskInputCharacters(KeyboardInputMask maskInputCharacters) {
setValue(KEY_MASK_INPUT_CHARACTERS, maskInputCharacters);
Expand All @@ -268,7 +268,7 @@ public KeyboardInputMask getMaskInputCharacters() {
* @param customKeys Array of special characters to show in customizable keys. If omitted, keyboard will show
* default special characters
* {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
*/
public KeyboardProperties setCustomKeys(List<String> customKeys) {
setValue(KEY_CUSTOM_KEYS, customKeys);
Expand All @@ -281,7 +281,7 @@ public KeyboardProperties setCustomKeys(List<String> customKeys) {
* @return List<String> Array of special characters to show in customizable keys. If omitted, keyboard will show
* default special characters
* {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
*/
@SuppressWarnings("unchecked")
public List<String> getCustomKeys() {
Expand Down
22 changes: 12 additions & 10 deletions base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>Description</th>
* <th>Req.</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
Expand All @@ -56,7 +57,8 @@
* <li>Min: 0</li>
* <li>Max: 2000000000</li>
* </ul>
* </td>
* </td>
* <th></th>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
Expand All @@ -70,7 +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>
* </td>
* <th></th>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
Expand All @@ -81,27 +84,26 @@
* <li>Min: 1</li>
* <li>Max: 100</li>
* </ul>
* </td>
* </td>
* <th></th>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>secondaryText</td>
* <td>String</td>
* <td>Optional secondary text to display</td>
* <td>Optional secondary text to display <br><br> {"string_min_length": 1, "string_max_length": 500}</td>
* <td>N</td>
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
* <td>tertiaryText</td>
* <td>String</td>
* <td>Optional tertiary text to display</td>
* <td>Optional tertiary text to display <br><br> {"string_min_length": 1, "string_max_length": 500}</td>
* <td>N</td>
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* SmartDeviceLink 7.1.0
* </td>
* </tr>
* </table>
Expand Down
Loading