Skip to content

Commit c94b54c

Browse files
noah-livionoah-livio
authored
Merge pull request #1810 from smartdevicelink/Fix-broken-tables
2 parents 180efd8 + d6553ff commit c94b54c

File tree

11 files changed

+124
-123
lines changed

11 files changed

+124
-123
lines changed

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,7 @@
113113
* <td>Optional secondary image struct for menu cell</td>
114114
* <td>N</td>
115115
* <td></td>
116-
* <td>
117-
* @since SmartDeviceLink 7.1.0
118-
* </td>
116+
* <td>SmartDeviceLink 7.1.0</td>
119117
* </tr>
120118
* </table>
121119
* <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>

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,29 +112,23 @@
112112
* <td>Optional secondary text to display</td>
113113
* <td>N</td>
114114
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
115-
* <td>
116-
* @since SmartDeviceLink 7.1.0
117-
* </td>
115+
* <td>SmartDeviceLink 7.1.0</td>
118116
* </tr>
119117
* <tr>
120118
* <td>tertiaryText</td>
121119
* <td>String</td>
122120
* <td>Optional tertiary text to display</td>
123121
* <td>N</td>
124122
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
125-
* <td>
126-
* @since SmartDeviceLink 7.1.0
127-
* </td>
123+
* <td>SmartDeviceLink 7.1.0</td>
128124
* </tr>
129125
* <tr>
130126
* <td>secondaryImage</td>
131127
* <td>Image</td>
132128
* <td>Optional secondary image struct for sub-menu cell</td>
133129
* <td>N</td>
134130
* <td></td>
135-
* <td>
136-
* @since SmartDeviceLink 7.1.0
137-
* </td>
131+
* <td>SmartDeviceLink 7.1.0</td>
138132
* </tr>
139133
* </table>
140134
* <b>Response</b>

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

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -85,71 +85,79 @@
8585
* <tr>
8686
* <td>driverDoorAjar</td>
8787
* <td>Boolean</td>
88-
* <td>true</td>
88+
* <td>false</td>
8989
* <td>The information about the park brake: - true, if active - false if not.</td>
9090
* <td>
91-
* @since SmartDeviceLink 2.0.0
92-
* @property-deprecated in SmartDeviceLink 7.1.0
91+
* SmartDeviceLink 2.0.0
92+
* <br>
93+
* <br>
94+
* Deprecated in SmartDeviceLink 7.1.0
9395
* </td>
9496
* </tr>
9597
* <tr>
9698
* <td>passengerDoorAjar</td>
9799
* <td>Boolean</td>
98-
* <td>true</td>
100+
* <td>false</td>
99101
* <td>The information about the park brake: - true, if active - false if not.</td>
100102
* <td>
101-
* @since SmartDeviceLink 2.0.0
102-
* @property-deprecated in SmartDeviceLink 7.1.0
103+
* SmartDeviceLink 2.0.0
104+
* <br>
105+
* <br>
106+
* Deprecated in SmartDeviceLink 7.1.0
103107
* </td>
104108
* </tr>
105109
* <tr>
106110
* <td>rearLeftDoorAjar</td>
107111
* <td>Boolean</td>
108-
* <td>true</td>
112+
* <td>false</td>
109113
* <td>The information about the park brake: - true, if active - false if not.</td>
110114
* <td>
111-
* @since SmartDeviceLink 2.0.0
112-
* @property-deprecated in SmartDeviceLink 7.1.0
115+
* SmartDeviceLink 2.0.0
116+
* <br>
117+
* <br>
118+
* Deprecated in SmartDeviceLink 7.1.0
113119
* </td>
114120
* </tr>
115121
* <tr>
116122
* <td>rearRightDoorAjar</td>
117123
* <td>Boolean</td>
118-
* <td>true</td>
124+
* <td>false</td>
119125
* <td>References signal "DrStatRr_B_Actl".</td>
120126
* <td>
121-
* @since SmartDeviceLink 2.0.0
122-
* @property-deprecated in SmartDeviceLink 7.1.0
127+
* SmartDeviceLink 2.0.0
128+
* <br>
129+
* <br>
130+
* Deprecated in SmartDeviceLink 7.1.0
123131
* </td>
124132
* </tr>
125133
* <tr>
126134
* <td>doorStatuses</td>
127135
* <td>List<DoorStatus></td>
128-
* <td>Provides status for doors if Ajar/Closed/Locked</td>
129-
* <td>N</td>
130-
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
136+
* <td>False</td>
137+
* <td>Provides status for doors if Ajar/Closed/Locked
138+
* {"array_min_size": 0, "array_max_size": 100}</td>
131139
* <td>
132-
* @since SmartDeviceLink 7.1.0
140+
* SmartDeviceLink 7.1.0
133141
* </td>
134142
* </tr>
135143
* <tr>
136144
* <td>gateStatuses</td>
137145
* <td>List<GateStatus></td>
138-
* <td>Provides status for trunk/hood/etc. if Ajar/Closed/Locked</td>
139-
* <td>N</td>
140-
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
146+
* <td>False</td>
147+
* <td>Provides status for trunk/hood/etc. if Ajar/Closed/Locked
148+
* {"array_min_size": 0, "array_max_size": 100}</td>
141149
* <td>
142-
* @since SmartDeviceLink 7.1.0
150+
* SmartDeviceLink 7.1.0
143151
* </td>
144152
* </tr>
145153
* <tr>
146154
* <td>roofStatuses</td>
147155
* <td>List<RoofStatus></td>
148-
* <td>Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.</td>
149-
* <td>N</td>
150-
* <td>{"array_min_size": 0, "array_max_size": 100}</td>
156+
* <td>False</td>
157+
* <td>Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/ Removedetc.
158+
* {"array_min_size": 0, "array_max_size": 100}</td>
151159
* <td>
152-
* @since SmartDeviceLink 7.1.0
160+
* SmartDeviceLink 7.1.0
153161
* </td>
154162
* </tr>
155163
* </table>

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

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,10 @@
112112
* <td>N</td>
113113
* <td>Subscribable</td>
114114
* <td>
115-
* @since SmartDeviceLink 2.0.0
116-
* @property-deprecated in SmartDeviceLink 7.1.0
115+
* SmartDeviceLink 2.0.0
116+
* <br>
117+
* <br>
118+
* Deprecated in SmartDeviceLink 7.1.0
117119
* </td>
118120
* </tr>
119121
* <tr>
@@ -124,19 +126,20 @@
124126
* <td>Subscribable</td>
125127
* <td>SmartDeviceLink 2.0</td>
126128
* </tr>
127-
* <tr>
128129
* <tr>
129130
* <td>gearStatus</td>
130131
* <td>Boolean</td>
131132
* <td>See GearStatus</td>
132-
* <td>N</td>
133+
* <td>N</td>
134+
* <td></td>
133135
* <td>SmartDeviceLink 7.0.0</td>
134136
* </tr>
135137
* <tr>
136138
* <td>prndl</td>
137139
* <td>Boolean</td>
138140
* <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
139-
* <td>N</td>
141+
* <td>N</td>
142+
* <td></td>
140143
* <td>SmartDeviceLink 7.0.0</td>
141144
* </tr>
142145
* <tr>
@@ -254,22 +257,25 @@
254257
* <td>stabilityControlsStatus</td>
255258
* <td>Boolean</td>
256259
* <td>See StabilityControlsStatus</td>
257-
* <td>N</td>
260+
* <td>N</td>
261+
* <td></td>
258262
* <td>SmartDeviceLink 7.0.0</td>
259263
* </tr>
260264
* </tr>
261265
* <tr>
262266
* <td>handsOffSteering</td>
263267
* <td>Boolean</td>
264268
* <td>To indicate whether driver hands are off the steering wheel</td>
265-
* <td>N</td>
269+
* <td>N</td>
270+
* <td></td>
266271
* <td>SmartDeviceLink 7.0.0</td>
267272
* </tr>
268273
* <tr>
269274
* <td>windowStatus</td>
270275
* <td>Boolean</td>
271276
* <td>See WindowStatus</td>
272-
* <td>N</td>
277+
* <td>N</td>
278+
* <td></td>
273279
* <td>SmartDeviceLink 7.0.0</td>
274280
* </tr>
275281
* <tr>
@@ -279,7 +285,7 @@
279285
* <td>N</td>
280286
* <td></td>
281287
* <td>
282-
* @since SmartDeviceLink 7.1.0
288+
* SmartDeviceLink 7.1.0
283289
* </td>
284290
* </tr>
285291
* <tr>
@@ -289,7 +295,7 @@
289295
* <td>N</td>
290296
* <td></td>
291297
* <td>
292-
* @since SmartDeviceLink 7.1.0
298+
* SmartDeviceLink 7.1.0
293299
* </td>
294300
* </tr>
295301
* </table>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
* <td>KeyboardInputMask</td>
108108
* <td>false</td>
109109
* <td>
110-
* @since SmartDeviceLink 7.1.0
110+
* SmartDeviceLink 7.1.0
111111
* </td>
112112
* <td>Allows an app to mask entered characters on HMI</td>
113113
* </tr>
@@ -116,7 +116,7 @@
116116
* <td>List<String></td>
117117
* <td>false</td>
118118
* <td>
119-
* @since SmartDeviceLink 7.1.0
119+
* SmartDeviceLink 7.1.0
120120
* </td>
121121
* <td>
122122
* Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters
@@ -245,7 +245,7 @@ public KeyboardProperties setAutoCompleteList(List<String> autoCompleteList) {
245245
* Sets the maskInputCharacters.
246246
*
247247
* @param maskInputCharacters Allows an app to mask entered characters on HMI
248-
* @since SmartDeviceLink 7.1.0
248+
* SmartDeviceLink 7.1.0
249249
*/
250250
public KeyboardProperties setMaskInputCharacters(KeyboardInputMask maskInputCharacters) {
251251
setValue(KEY_MASK_INPUT_CHARACTERS, maskInputCharacters);
@@ -268,7 +268,7 @@ public KeyboardInputMask getMaskInputCharacters() {
268268
* @param customKeys Array of special characters to show in customizable keys. If omitted, keyboard will show
269269
* default special characters
270270
* {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
271-
* @since SmartDeviceLink 7.1.0
271+
* SmartDeviceLink 7.1.0
272272
*/
273273
public KeyboardProperties setCustomKeys(List<String> customKeys) {
274274
setValue(KEY_CUSTOM_KEYS, customKeys);
@@ -281,7 +281,7 @@ public KeyboardProperties setCustomKeys(List<String> customKeys) {
281281
* @return List<String> Array of special characters to show in customizable keys. If omitted, keyboard will show
282282
* default special characters
283283
* {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
284-
* @since SmartDeviceLink 7.1.0
284+
* SmartDeviceLink 7.1.0
285285
*/
286286
@SuppressWarnings("unchecked")
287287
public List<String> getCustomKeys() {

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@
4444
* <tr>
4545
* <th>Name</th>
4646
* <th>Type</th>
47-
* <th>Description</th>
47+
* <th>Description</th>
48+
* <th>Req.</th>
4849
* <th>SmartDeviceLink Ver. Available</th>
4950
* </tr>
5051
* <tr>
@@ -56,7 +57,8 @@
5657
* <li>Min: 0</li>
5758
* <li>Max: 2000000000</li>
5859
* </ul>
59-
* </td>
60+
* </td>
61+
* <th></th>
6062
* <td>SmartDeviceLink 1.0</td>
6163
* </tr>
6264
* <tr>
@@ -70,7 +72,8 @@
7072
* <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>
7173
* <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
7274
* </ul>
73-
* </td>
75+
* </td>
76+
* <th></th>
7477
* <td>SmartDeviceLink 1.0</td>
7578
* </tr>
7679
* <tr>
@@ -81,27 +84,26 @@
8184
* <li>Min: 1</li>
8285
* <li>Max: 100</li>
8386
* </ul>
84-
* </td>
87+
* </td>
88+
* <th></th>
8589
* <td>SmartDeviceLink 1.0</td>
8690
* </tr>
8791
* <tr>
8892
* <td>secondaryText</td>
8993
* <td>String</td>
90-
* <td>Optional secondary text to display</td>
94+
* <td>Optional secondary text to display <br><br> {"string_min_length": 1, "string_max_length": 500}</td>
9195
* <td>N</td>
92-
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
9396
* <td>
94-
* @since SmartDeviceLink 7.1.0
97+
* SmartDeviceLink 7.1.0
9598
* </td>
9699
* </tr>
97100
* <tr>
98101
* <td>tertiaryText</td>
99102
* <td>String</td>
100-
* <td>Optional tertiary text to display</td>
103+
* <td>Optional tertiary text to display <br><br> {"string_min_length": 1, "string_max_length": 500}</td>
101104
* <td>N</td>
102-
* <td>{"string_min_length": 1, "string_max_length": 500}</td>
103105
* <td>
104-
* @since SmartDeviceLink 7.1.0
106+
* SmartDeviceLink 7.1.0
105107
* </td>
106108
* </tr>
107109
* </table>

0 commit comments

Comments
 (0)