diff options
| author | HansenKirk <khanse23@ford.com> | 2015-09-25 13:47:33 -0400 |
|---|---|---|
| committer | HansenKirk <khanse23@ford.com> | 2015-09-25 13:47:33 -0400 |
| commit | 40961da2455c5eefced3e66aa2931be6950fce11 (patch) | |
| tree | eb7760c8f00e0a194fd956955364e55793bd7ebc | |
| parent | 7c334095a2653a2d2f9d13c0994f0836d8ce9290 (diff) | |
| download | sdl_android-feature/ongoing-docs.tar.gz | |
updated documentationfeature/ongoing-docs
129 files changed, 1196 insertions, 1193 deletions
diff --git a/sdl_android_lib/project.properties b/sdl_android_lib/project.properties index e61077f79..73e806d74 100644 --- a/sdl_android_lib/project.properties +++ b/sdl_android_lib/project.properties @@ -8,5 +8,5 @@ # project structure. # Project target. -target=android-17 +target=android-20 android.library=true diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java index 4527602a3..0a4dc2a70 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/RPCResponse.java @@ -22,18 +22,18 @@ import com.smartdevicelink.proxy.rpc.enums.Result; * </li> <li>ResultCode:
* <ul>
*
- * The result code provides additional information about a response returning a
- * failed outcome.
- * <br>
+ * <p>The result code provides additional information about a response returning a
+ * failed outcome.</p>
*
- * Any response can have at least one, or possibly more, of the following result
+ *
+ * <p>Any response can have at least one, or possibly more, of the following result
* code values: SUCCESS, INVALID_DATA, OUT_OF_MEMORY, TOO_MANY_PENDING_REQUESTS,
- * APPLICATION_NOT_REGISTERED, GENERIC_ERROR,REJECTED.
- * <br>
+ * APPLICATION_NOT_REGISTERED, GENERIC_ERROR,REJECTED.</p>
+ *
+ *
+ * <p>Any additional result codes for a given operation can be found in related
+ * RPCs</p>
*
- * Any additional result codes for a given operation can be found in related
- * RPCs
- * <br>
* </ul>
* </li> <li>Info:
* <ul>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java index 9c91c7ee3..57b58ea5b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddCommand.java @@ -8,24 +8,24 @@ import com.smartdevicelink.proxy.RPCRequest; import com.smartdevicelink.util.DebugTool;
/**
-* <p>
-* This class will add a command to the application's Command Menu
-* </p>
-* <p>
-* <b>Note:</b> A command will be added to the end of the list of elements in
-* the Command Menu under the following conditions:
-* </p>
+*
+* <p>This class will add a command to the application's Command Menu</p>
+*
+*
+* <p><b>Note:</b> A command will be added to the end of the list of elements in
+* the Command Menu under the following conditions:</p>
+*
* <ul>
* <li>When a Command is added with no MenuParams value provided</li>
* <li>When a MenuParams value is provided with a MenuParam.position value
* greater than or equal to the number of menu items currently defined in the
* menu specified by the MenuParam.parentID value</li>
* </ul>
-* <br/>
-* <p>
-* The set of choices which the application builds using AddCommand can be a
-* mixture of:
-* </p>
+*
+*
+* <p>The set of choices which the application builds using AddCommand can be a
+* mixture of:</p>
+*
* <ul>
* <li>Choices having only VR synonym definitions, but no MenuParams definitions
* </li>
@@ -33,10 +33,10 @@ import com.smartdevicelink.util.DebugTool; * </li>
* <li>Choices having both MenuParams and VR synonym definitions</li>
* </ul>
-* <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b>
-* </p>
- * <p><b>Parameter List</b>
+*
+* <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
+*
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -46,12 +46,12 @@ import com.smartdevicelink.util.DebugTool; * <th>Notes</th>
* <th>Version Available</th>
* </tr>
-* <tr>
+ * <tr>
* <td>cmdID</td>
* <td> Integer</td>
* <td>unique ID of the command to add</td>
* <td>Y</td>
- * <td> minvalue:0<br>maxvalue:2000000000</td>
+ * <td> minvalue:0; maxvalue:2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* <tr>
* <td>menuParams</td>
@@ -64,22 +64,22 @@ import com.smartdevicelink.util.DebugTool; * <tr>
* <td>vrCommands</td>
* <td>String</td>
- * <td>An array of strings to be used as VR synonyms for this command.<br> If this array is provided, it may not be empty.</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<br> maxsize:100</td>
+ * <td>minsize:1; maxsize:100</td>
* <td>SmartDeviceLink 1.0</td>
* <tr>
* <td>cmdIcon</td>
* <td>Image</td>
- * <td>Image struct determining whether static or dynamic icon.<br>If omitted on supported displays, no (or the default if applicable) icon shall be displayed.</td>
+ * <td><p>Image struct determining whether static or dynamic icon.</p><p>If omitted on supported displays, no (or the default if applicable) icon shall be displayed.</p></td>
* <td>N</td>
* <td></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
-* <b>Response</b><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. <br>
-* <p>
-* <b>Non-default Result Codes:</b><br> INVALID_ID<br> DUPLICATE_NAME
+* <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>
+*
+* <p><b>Non-default Result Codes:</b></p> <p>INVALID_ID</p> <p>DUPLICATE_NAME</p>
* @since SmartDeviceLink 1.0
* @see DeleteCommand
* @see AddSubMenu
@@ -122,15 +122,15 @@ public class AddCommand extends RPCRequest { return (Integer) parameters.get(KEY_CMD_ID);
}
/**
- * Sets an Unique Command ID that identifies the command. Is returned in an
+ * <p>Sets an Unique Command ID that identifies the command. Is returned in an
* <i>{@linkplain OnCommand}</i> notification to identify the command
- * selected by the user
- * <p>
+ * selected by the user</p>
+ *
*
* @param cmdID
* an integer object representing a Command ID
* <p>
- * <b>Notes:</b> Min Value: 0; Max Value: 2000000000
+ * <b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
*/
public void setCmdID(Integer cmdID) {
if (cmdID != null) {
@@ -146,6 +146,7 @@ public class AddCommand extends RPCRequest { * </p>
*
* @return MenuParams -a MenuParams object
+ *
*/
@SuppressWarnings("unchecked")
public MenuParams getMenuParams() {
@@ -164,9 +165,9 @@ public class AddCommand extends RPCRequest { }
/**
* <p>
- * Sets Menu parameters<br/>
+ * Sets Menu parameters</p>
* If provided, this will define the command and how it is added to the
- * Command Menu<br/>
+ * Command Menu<p>
* If null, commands will not be accessible through the HMI application menu
* </p>
*
@@ -202,11 +203,11 @@ public class AddCommand extends RPCRequest { }
/**
* <p>
- * Sets Voice Recognition Commands <br/>
- * If provided, defines one or more VR phrases the recognition of any of
+ * Sets Voice Recognition Commands </p>
+ * <p>If provided, defines one or more VR phrases the recognition of any of
* which triggers the <i>{@linkplain OnCommand}</i> notification with this
- * cmdID<br/>
- * If null, commands will not be accessible by voice commands (when the user
+ * cmdID</p>
+ * <p>If null, commands will not be accessible by voice commands (when the user
* hits push-to-talk)
* </p>
*
@@ -215,7 +216,7 @@ public class AddCommand extends RPCRequest { * <p>
* <b>Notes: </b>Optional only if menuParams is provided. If
* provided, array must contain at least one non-empty (not null,
- * not zero-length, not whitespace only) element
+ * not zero-length, not whitespace only) element</p>
*/
public void setVrCommands( List<String> vrCommands ) {
if (vrCommands != null) {
@@ -226,7 +227,7 @@ public class AddCommand extends RPCRequest { }
/**
- * Gets the image to be shown along with a command </p>
+ * <p>Gets the image to be shown along with a command </p>
*
* @return Image -an Image object
* @since SmartDeviceLink 2.0
@@ -247,14 +248,14 @@ public class AddCommand extends RPCRequest { }
/**
- * Sets the Image<br/>
- * If provided, defines the image to be be shown along with a command
+ * <p>Sets the Image
+ * If provided, defines the image to be be shown along with a command</p>
* @param cmdIcon
- * an Image obj representing the Image obj shown along with a
- * command
+ * <p>an Image obj representing the Image obj shown along with a
+ * command</p>
* <p>
* <b>Notes: </b>If omitted on supported displays, no (or the
- * default if applicable) icon will be displayed
+ * default if applicable) icon will be displayed</p>
* @since SmartDeviceLink 2.0
*/
public void setCmdIcon(Image cmdIcon) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java index 13d40a65e..2edc70c50 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AddSubMenu.java @@ -6,15 +6,15 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Add a SubMenu to the Command Menu
- * <p>
- * A SubMenu can only be added to the Top Level Menu (i.e.a SubMenu cannot be
- * added to a SubMenu), and may only contain commands as children
- * <p>
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b>
- * </p>
- * <p><b>Parameter List</b>
+ * <p>Add a SubMenu to the Command Menu</p>
+ *
+ * <p>A SubMenu can only be added to the Top Level Menu (i.e.a SubMenu cannot be
+ * added to a SubMenu), and may only contain commands as children</p>
+ *
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -37,7 +37,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.</td>
* <td>N</td>
- * <td>Min Value: 0 <br>Max Value: 1000<br> If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.<br>If this parameter is omitted, the entry will be added at the end of the list.</td>
+ * <td>Min Value: 0 <p>Max Value: 1000</p> <p>If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.</p><p>If this parameter is omitted, the entry will be added at the end of the list.</P></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -50,11 +50,11 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
* </table>
* <b>Response</b>
- * <p>Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the SubMenu was added to the Command Menu successfully<br>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * - INVALID_ID<br>
- * - DUPLICATE NAME<br>
+ * <p>Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the SubMenu was added to the Command Menu successfully</p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>INVALID_ID</p>
+ * <p>DUPLICATE NAME</p>
* @since SmartDeviceLink 1.0
* @see DeleteSubMenu
* @see AddCommand
@@ -73,7 +73,7 @@ public class AddSubMenu extends RPCRequest { }
/**
* Constructs a new AddSubMenu object indicated by the Hashtable parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -84,7 +84,7 @@ public class AddSubMenu extends RPCRequest { /**
* Returns an <i>Integer</i> object representing the Menu ID that identifies
* a sub menu
- * <p>
+ *
*
* @return Integer -an integer representing the Menu ID that identifies a sub
* menu
@@ -93,15 +93,15 @@ public class AddSubMenu extends RPCRequest { return (Integer) parameters.get( KEY_MENU_ID );
}
/**
- * Sets a Menu ID that identifies a sub menu. This value is used in
+ * <p>Sets a Menu ID that identifies a sub menu.</p><p> This value is used in
* {@linkplain AddCommand} to which SubMenu is the parent of the command
- * being added
- * <p>
+ * being added</p>
+ *
*
* @param menuID
* an integer object representing a Menu ID
- * <p>
- * <b>Notes:</b> Min Value: 0; Max Value: 2000000000
+ *
+ * <p><b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
*/
public void setMenuID( Integer menuID ) {
if (menuID != null) {
@@ -111,8 +111,8 @@ public class AddSubMenu extends RPCRequest { }
}
/**
- * Returns an <i>Integer</i> object representing the position of menu
- * <p>
+ * <p>Returns an <i>Integer</i> object representing the position of menu</p>
+ *
*
* @return Integer -the value representing the relative position of menus
*/
@@ -123,13 +123,13 @@ public class AddSubMenu extends RPCRequest { * Sets a position of menu
*
* @param position
- * An Integer object representing the position within the items
+ * <p>An Integer object representing the position within the items
* of the top level Command Menu. 0 will insert at the front, 1
* will insert after the first existing element, etc. Position of
* any submenu will always be located before the return and exit
* options
- * <p>
- * <b>Notes: </b><br/>
+ * </p>
+ * <b>Notes: </b>
* <ul>
* <li>
* Min Value: 0; Max Value: 1000</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java index 10a236d42..b80a9c2c4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AirbagStatus.java @@ -5,11 +5,11 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus;
/**
- * The status of the air bags.
- *<p>
+ * <p>The status of the air bags.</p>
*
*
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -67,18 +67,18 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus; * </tr>
*
* </table>
- * <p>
- * <b>Response:</b><br>
+ *
+ * <p><b>Response:</b></p>
* If a resultCode of "SUCCESS" is returned, the request was accepted by SDL. By the time the corresponding response is received, the Alert will have completed.
- * <p>
- * <b> Non-default Result Codes:</b><br>
- * - REJECTED<br>- ABORTED
*
+ * <p><b> Non-default Result Codes:</b></p>
+ * <p>REJECTED</p><p> ABORTED</P>
+ *
+ *
+ * @since SmartDeviceLink 1.0
*
- * @since SmartDeviceLink 1.0
- * <p>
- * @see TextFieldName
- * @see Image
+ * @see TextFieldName
+ * @see Image
* @see SubscribeVehicleData
*/
public class AirbagStatus extends RPCStruct {
@@ -90,9 +90,9 @@ public class AirbagStatus extends RPCStruct { public static final String KEY_PASSENGER_SIDE_AIRBAG_DEPLOYED = "passengerSideAirbagDeployed";
public static final String KEY_PASSENGER_CURTAIN_AIRBAG_DEPLOYED = "passengerCurtainAirbagDeployed";
public static final String KEY_PASSENGER_KNEE_AIRBAG_DEPLOYED = "passengerKneeAirbagDeployed";
- /** Constructs a new AirbagStatus object indicated by the Hashtable<br>
+ /** Constructs a new AirbagStatus object indicated by the Hashtable
* parameter
- * @Param hash
+ * @param hash
* The hash table to use
*
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java index 02ee592a4..811d65a42 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Alert.java @@ -10,7 +10,7 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Provides information to the user using either TTS, the Display or both and
* can include a system-generated alert tone
- * <p>
+ *
* <ul>
* <li>The displayed portion of the Alert, if any, will persist until the
* specified timeout has elapsed, or the Alert is preempted</li>
@@ -20,7 +20,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <li>An Alert can be preempted by a user action (button push)</li>
* <li>An Alert will fail if it is issued while another Alert is in progress</li>
* <li>Although each Alert parameter is optional, in fact each Alert request
- * must supply at least one of the following parameters:<br/>
+ * must supply at least one of the following parameters:
* <ul>
* <li>alertText1</li>
* <li>alertText2</li>
@@ -29,11 +29,11 @@ import com.smartdevicelink.proxy.RPCRequest; * </ul>
* </li>
* </ul>
- * <br/>
- * <b>HMILevel needs to be FULL or LIMITED.</b><br/>
+ *
+ * <p><b>HMILevel needs to be FULL or LIMITED.</b></p>
* <b>If the app has been granted function group Notification the HMILevel can
- * also be BACKGROUND</b><br/>
- * <table border="1" rules="all">
+ * also be BACKGROUND</b>
+ * <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
@@ -55,7 +55,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>String</td>
* <td>Text to be displayed in the second field of the display during the Alert. </td>
* <td>N</td>
- * <td> Only permitted if HMI supports a second display line.<br> Length is limited to what is indicated in RegisterAppInterface response. <br> If omitted, second display line will be cleared. </td>
+ * <td> Only permitted if HMI supports a second display line. Length is limited to what is indicated in RegisterAppInterface response. If omitted, second display line will be cleared. </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -76,10 +76,10 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
* <tr>
* <td>duration</td>
- * <td>Int32</td>
- * <td>The duration of the displayed portion of the alert, in milliseconds.<br> After this amount of time has passed, the display fields<br> alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</td>
+ * <td>Integer</td>
+ * <td><p>The duration of the displayed portion of the alert, in milliseconds.</p> After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</td>
* <td>N</td>
- * <td>Min Value: 3000 <br> Max Value: 10000<br> If omitted, the default is 5000 milliseconds</td>
+ * <td>Min Value: 3000 Max Value: 10000 <p>If omitted, the default is 5000 milliseconds</p></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -95,7 +95,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SoftButton[]</td>
* <td>Specifies the softbuttons, the apps wants to use in this alert.</td>
* <td></td>
- * <td>If omitted on supported displays, the alert will not have any SoftButton.<br> ArrayMin: 0<br> ArrayMax: 4</td>
+ * <td>If omitted on supported displays, the alert will not have any SoftButton.ArrayMin: 0; ArrayMax: 4</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -132,8 +132,8 @@ public class Alert extends RPCRequest { super(FunctionID.ALERT.toString());
}
/**
- * Constructs a new Alert object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new Alert object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -157,8 +157,8 @@ public class Alert extends RPCRequest { *
* @param alertText1
* String Value
- * <p>
- * <b>Notes: </b><br/>
+ *
+ * <p><b>Notes: </b></p>
* <ul>
* <li>Length is limited to what is indicated in <i>
* {@linkplain RegisterAppInterface}</i> response</li>
@@ -189,8 +189,8 @@ public class Alert extends RPCRequest { *
* @param alertText2
* String Value
- * <p>
- * <b>Notes: </b><br/>
+ *
+ * <p><b>Notes: </b></p>
* <ul>
* <li>Only permitted if HMI supports a second display line</li>
* <li>Length is limited to what is indicated in <i>
@@ -226,8 +226,8 @@ public class Alert extends RPCRequest { *
* @param alertText3
* String Value
- * <p>
- * <b>Notes: </b><br/>
+ *
+ * <p> <b>Notes: </b></p>
* <ul>
* <li>Only permitted if HMI supports a third display line</li>
* <li>Length is limited to what is indicated in <i>
@@ -276,8 +276,8 @@ public class Alert extends RPCRequest { * spoken to the user
*
* @param ttsChunks
- * <p>
- * <b>Notes: </b>Array must have a least one element
+ *
+ * <p> <b>Notes: </b>Array must have a least one element</p>
*/
public void setTtsChunks(List<TTSChunk> ttsChunks) {
if (ttsChunks != null) {
@@ -296,17 +296,17 @@ public class Alert extends RPCRequest { return (Integer) parameters.get(KEY_DURATION);
}
/**
- * Sets the duration of the displayed portion of the alert, in milliseconds.
+ * <p>Sets the duration of the displayed portion of the alert, in milliseconds.
* After this amount of time has passed, the display fields alertText1 and
* alertText2 will revert to what was displayed in those fields before the
- * alert began
- * <p>
+ * alert began</p>
+ *
*
* @param duration
* the Integer values representing the duration time, in
* milliseconds
* <p>
- * <b>Notes: </b><br/>
+ * <b>Notes: </b></p>
* <ul>
* <li>Min Value: 3000; Max Value: 10000</li>
* <li>If omitted, the default is 5000 milliseconds</li>
@@ -335,8 +335,8 @@ public class Alert extends RPCRequest { * @param playTone
* a Boolean value which specifies whether the alert tone should
* be played before the TTS (if any) is spoken
- * <p>
- * <b>Notes: </b>If omitted, default is true
+ *
+ * <p> <b>Notes: </b>If omitted, default is true</p>
*/
public void setPlayTone(Boolean playTone) {
if (playTone != null) {
@@ -379,7 +379,7 @@ public class Alert extends RPCRequest { * @param softButtons
* a List<SoftButton> value
* <p>
- * <b>Notes: </b><br/>
+ * <b>Notes: </b></p>
* <ul>
* <li>If omitted on supported displays, the alert will not have
* any SoftButton</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java index 9aab52589..fba595150 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertManeuver.java @@ -8,13 +8,13 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest; /** - * This will bring up an alert with information related to the next navigation maneuver including potential voice + * <p>This will bring up an alert with information related to the next navigation maneuver including potential voice * navigation instructions. Shown information will be taken from the ShowConstantTBT function - * <p> - * Function Group: Navigation - * <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * <p> + * </p> + * <p>Function Group: Navigation</p> + * + * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> + * * * @since SmartDeviceLink 2.0 * @see ShowConstantTbt @@ -32,9 +32,9 @@ public class AlertManeuver extends RPCRequest{ } /** - * <p> - * Constructs a new AlertManeuver object indicated by the Hashtable parameter - * </p> + * + * <p>Constructs a new AlertManeuver object indicated by the Hashtable parameter</p> + * * * @param hash * The Hashtable to use @@ -76,7 +76,7 @@ public class AlertManeuver extends RPCRequest{ * @param softButtons * a List<SoftButton> value * <p> - * <b>Notes: </b><br/> + * <b>Notes: </b></p> * <ul> * <li>If omitted on supported displays, the alert will not have any SoftButton</li> * <li>ArrayMin: 0</li> @@ -125,7 +125,7 @@ public class AlertManeuver extends RPCRequest{ * * @param ttsChunks * <p> - * <b>Notes: </b>Array must have a least one element + * <b>Notes: </b></p>Array must have a least one element */ public void setTtsChunks(List<TTSChunk> ttsChunks){ if(ttsChunks != null){ diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java index fc01fbe63..cea706d4e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AlertResponse.java @@ -21,9 +21,9 @@ public class AlertResponse extends RPCResponse { }
/**
- * Constructs a new AlertResponse object indicated by the Hashtable
+ * <p>Constructs a new AlertResponse object indicated by the Hashtable
* parameter
- * <p>
+ * </p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java index 1d6def5b3..48cfd129b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java @@ -8,10 +8,10 @@ import com.smartdevicelink.proxy.rpc.enums.BitsPerSample; import com.smartdevicelink.proxy.rpc.enums.SamplingRate;
/**
- * Describes different audio type configurations for PerformAudioPassThru, e.g. {8kHz,8-bit,PCM}<br>
- * Specifies the capabilities of audio capturing: sampling rate, bits per sample, audio type.<br>
+ *<p> Describes different audio type configurations for PerformAudioPassThru, e.g. {8kHz,8-bit,PCM}
+ * Specifies the capabilities of audio capturing: sampling rate, bits per sample, audio type.</p>
*
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java index 19903468d..71db21640 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BeltStatus.java @@ -4,10 +4,10 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus;
-/** The status of the seat belts.<br>
+/** The status of the seat belts.
*
- * <p><b>Parameter List</b>
- * <p>
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -129,9 +129,9 @@ public class BeltStatus extends RPCStruct { public static final String KEY_RIGHT_REAR_INFLATABLE_BELTED = "rightRearInflatableBelted";
public static final String KEY_MIDDLE_ROW_1_BELT_DEPLOYED = "middleRow1BeltDeployed";
public static final String KEY_MIDDLE_ROW_1_BUCKLE_BELTED = "middleRow1BuckleBelted";
- /** Constructs a new BeltStatus object indicated by the Hashtable<br>
+ /** Constructs a new BeltStatus object indicated by the Hashtable
* parameter
- * @Param hash
+ * @param hash
* The hash table to use
*
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java index 78a1e6d67..038b1970e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/BodyInformation.java @@ -6,10 +6,10 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.IgnitionStableStatus;
import com.smartdevicelink.proxy.rpc.enums.IgnitionStatus;
/** The body information including power modes.
- * <p>
- * <b>Note:</b> The structure defines the information about the park brake and ignition.
*
- * <p><b>Parameter List</b>
+ * <p><b>Note:</b> The structure defines the information about the park brake and ignition.</p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -91,7 +91,7 @@ public class BodyInformation extends RPCStruct { public static final String KEY_PASSENGER_DOOR_AJAR = "passengerDoorAjar";
public static final String KEY_REAR_LEFT_DOOR_AJAR = "rearLeftDoorAjar";
public static final String KEY_REAR_RIGHT_DOOR_AJAR = "rearRightDoorAjar";
- /** Constructs a new BodyInformation object indicated by the Hashtable<br>
+ /** Constructs a new BodyInformation object indicated by the Hashtable
* parameter
* @param hash
* The hash table to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java index 6dca5b7ae..9b15c5be9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; /**
* Provides information about the capabilities of a SDL HMI button.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -37,18 +37,18 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * <td>upDownAvailable</td>
* <td>Boolean</td>
* <td>The button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
- * <p> When the button is released, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONUP.</td>
+ * <p> When the button is released, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONUP.</p></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- * <p>
- * Upon the request HMI must provide the list of the following information:<br>
- * The names of all existing/supported hardware buttons.<br>
- * The availability of LONG/SHORT press for each existing/supported hardware button correspondingly<br>
- * The availability of UP/DOWN events for each existing/supported hardware button correspondingly.<br>
- * <p>
+ *
+ * <p>Upon the request HMI must provide the list of the following information:</p>
+ * <p>The names of all existing/supported hardware buttons.</p>
+ * <p>The availability of LONG/SHORT press for each existing/supported hardware button correspondingly</p>
+ * <p>The availability of UP/DOWN events for each existing/supported hardware button correspondingly.</p>
+ *
* @since SmartDeviceLink 1.0
- * <p>
+ *
* @see ButtonName
* @see ButtonEventMode
* @see ButtonPressMode
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java index 7877d7a2e..2b4c69f42 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistration.java @@ -13,16 +13,16 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * (voice/TTS and/or display) does not match the app language, the app will be
* able (but does not need) to change this registration with changeRegistration
* prior to app being brought into focus.
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel can by any</b>
- * <p>
- * <b>Note:</b><br>
- * <p>
- * SDL will send the language value confirmed to be supported by HMI via UI.GetCapabilities.<br>
- * <p><b> Parameter List</b>
- * <table border="1" rules="all">
+ *
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel can by any</b></p>
+ *
+ * <b>Note:</b>
+ *
+ * <p>SDL will send the language value confirmed to be supported by HMI via UI.GetCapabilities.</p>
+ * <p><b> Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -45,11 +45,11 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>Language</td>
* <td>Request display language registration.</td>
* <td>Y</td>
- * <td>Minvalue=0 <br>Maxvalue=2000000000</td>
+ * <td>Minvalue=0; Maxvalue=2000000000</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
-* <tr>
+ * <tr>
* <td>appName</td>
* <td>String</td>
* <td>Request new app name registration</td>
@@ -62,7 +62,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>TTSChunk</td>
* <td>Request new ttsName registration</td>
* <td>N</td>
- * <td>minsize:1<br> maxsize:100</td>
+ * <td>minsize:1; maxsize:100</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -78,23 +78,22 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>String</td>
* <td>Request new VR synonyms registration</td>
* <td>N</td>
- * <td>maxlength: 40<br>minsize:1<br>maxsize:100</td>
+ * <td>maxlength: 40; minsize:1; maxsize:100</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * <p>
- * <b>Response </b><br>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * DISALLOWED<br>
-
+ *
+ * <p><b>Response </b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED</p>
*
* @since SmartDeviceLink 2.0
* @see RegisterAppInterface
@@ -115,9 +114,9 @@ public class ChangeRegistration extends RPCRequest { }
/**
- * Constructs a new ChangeRegistration object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new ChangeRegistration object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -299,7 +298,7 @@ public class ChangeRegistration extends RPCRequest { * a List<String> value representing the an array of 1-100
* elements
* <p>
- * <b>Notes: </b>
+ * <b>Notes: </b></p>
* <ul>
* <li>Each vr synonym is limited to 40 characters, and there can
* be 1-100 synonyms in array</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java index 0ab62ba49..e5404cad3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ChangeRegistrationResponse.java @@ -20,9 +20,9 @@ public class ChangeRegistrationResponse extends RPCResponse { }
/**
- * Constructs a new ChangeRegistrationResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new ChangeRegistrationResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java index ffb85760a..2bc59736e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Choice.java @@ -7,9 +7,9 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.util.DebugTool;
/**
- * A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.<br>
+ * A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
* For example, the application may request for the user`s choice among several suggested ones: Yes, No, Skip.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -19,10 +19,10 @@ import com.smartdevicelink.util.DebugTool; * </tr>
* <tr>
* <td>choiceID</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>Application-scoped identifier that uniquely identifies this choice.
- * <br/>Min: 0
- * <br/>Max: 65535
+ * Min: 0;
+ * Max: 65535
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
@@ -30,8 +30,8 @@ import com.smartdevicelink.util.DebugTool; * <td>menuName</td>
* <td>String</td>
* <td>Text which appears in menu, representing this choice.
- * <br/>Min: 1
- * <br/>Max: 100
+ * Min: 1;
+ * Max: 100
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
@@ -50,7 +50,7 @@ import com.smartdevicelink.util.DebugTool; * </table>
*
* @since SmartDeviceLink 1.0
- * <p>
+ *
* @see AddCommand
* @see PerformInteraction
* @see Image
@@ -76,7 +76,7 @@ public class Choice extends RPCStruct { }
/**
* Get the application-scoped identifier that uniquely identifies this choice.
- * @return choiceID Min: 0 Max: 65535
+ * @return choiceID Min: 0; Max: 65535
*/
public Integer getChoiceID() {
return (Integer) store.get(KEY_CHOICE_ID);
@@ -94,8 +94,8 @@ public class Choice extends RPCStruct { }
/**
* Text which appears in menu, representing this choice.
- * <br/>Min: 1
- * <br/>Max: 100
+ * Min: 1;
+ * Max: 100
* @return menuName the menu name
*/
public String getMenuName() {
@@ -103,8 +103,8 @@ public class Choice extends RPCStruct { }
/**
* Text which appears in menu, representing this choice.
- * <br/>Min: 1
- * <br/>Max: 100
+ * Min: 1;
+ * Max: 100
* @param menuName the menu name
*/
public void setMenuName(String menuName) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java index f122d9dfb..17e16af65 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java @@ -6,10 +6,10 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.CarModeStatus;
import com.smartdevicelink.proxy.rpc.enums.PowerModeQualificationStatus;
import com.smartdevicelink.proxy.rpc.enums.PowerModeStatus;
-/** The status modes of the instrument panel cluster.
- * <p>
+/** <p>The status modes of the instrument panel cluster.</p>
*
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -43,9 +43,8 @@ import com.smartdevicelink.proxy.rpc.enums.PowerModeStatus; * </tr>
*
* </table>
-
* @since SmartDeviceLink 1.0
- * <p>
+ *
* @see SubscribeVehicleData
* @see SubscribeVehicleData
* @see Image
@@ -57,9 +56,9 @@ public class ClusterModeStatus extends RPCStruct { public static final String KEY_POWER_MODE_QUALIFICATION_STATUS = "powerModeQualificationStatus";
public static final String KEY_CAR_MODE_STATUS = "carModeStatus";
public static final String KEY_POWER_MODE_STATUS = "powerModeStatus";
- /** Constructs a new ClusterModeStatus object indicated by the Hashtable<br>
- * parameter
- * @Param hash
+ /** <p>Constructs a new ClusterModeStatus object indicated by the Hashtable
+ * parameter</p>
+ * @param hash
* The hash table to use
*
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java index 6dc9d1b74..97793558f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java @@ -10,16 +10,16 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Creates a Choice Set which can be used in subsequent <i>
* {@linkplain PerformInteraction}</i> Operations.
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
- * AudioStreamingState : ANY<br>
- * <p>
- * SystemContext: MAIN, MENU, VR<br>
- * </p>
- * <p><b>Parameter List</b><br>
+ *
+ * <p>Function Group: Base </p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p>AudioStreamingState : ANY</p>
+ *
+ * <p>SystemContext: MAIN, MENU, VR</p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -31,10 +31,10 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
* <tr>
* <td>interactionChoiceSetID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>A unique ID that identifies the Choice Set</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value: 2000000000</td>
+ * <td>Min Value: 0; Max Value: 2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -42,32 +42,32 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Choice[]</td>
* <td>Array of one or more elements.</td>
* <td>Y</td>
- * <td>Min Value: 1<br>Max Value: 100</td>
+ * <td>Min Value: 1; Max Value: 100</td>
* <td>SmartDeviceLink 1.0 </td>
* </tr>
* </table>
- * <p>
+ *
*
- * <b>Note:</b><br>Second Utterance issue with CreateInteractionChoiceSet RPC. <br> Before a perform interaction
- * is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.<br>
+ * <p> <b>Note:</b></p>Second Utterance issue with CreateInteractionChoiceSet RPC. Before a perform interaction
+ * is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
* If you do not wait the system may not recognize the first utterance from the user.
- * </p>
- * <b>Response</b><br>
- *<p>
+ *
+ * <p><b>Response</b></p>
+ *
* Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the Choice Set was created.
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * INVALID_ID<br>
- * DUPLICATE_NAME<br>
- * UNSUPPORTED_RESOURCE <br>
- * <p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> INVALID_ID</p>
+ * <p> DUPLICATE_NAME</p>
+ * <p>UNSUPPORTED_RESOURCE </p>
+ *
*
* @since SmartDeviceLink 1.0
* @see DeleteInteractionChoiceSet
@@ -84,9 +84,9 @@ public class CreateInteractionChoiceSet extends RPCRequest { super(FunctionID.CREATE_INTERACTION_CHOICE_SET.toString());
}
/**
- * Constructs a new CreateInteractionChoiceSet object indicated by the
- * Hashtable parameter
- * <p>
+ * <p>Constructs a new CreateInteractionChoiceSet object indicated by the
+ * Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -107,7 +107,7 @@ public class CreateInteractionChoiceSet extends RPCRequest { *
* @param interactionChoiceSetID
* an Integer value representing the Choice Set ID
- * <p>
+ *
* <b>Notes: </b>Min Value: 0; Max Value: 2000000000
*/
public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {
@@ -148,7 +148,7 @@ public class CreateInteractionChoiceSet extends RPCRequest { * @param choiceSet
* a List<Choice> representing the array of one or more
* elements
- * <p>
+ *
* <b>Notes: </b>Min Value: 1; Max Value: 100
*/
public void setChoiceSet( List<Choice> choiceSet ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java index c580a8277..84afe2a70 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DIDResult.java @@ -5,8 +5,8 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataResultCode;
/** Individual requested DID result and data.
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -39,7 +39,7 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataResultCode; * </tr>
* </table>
* @since SmartDeviceLink 1.0
- * <p>
+ *
* @see VehicleDataResultCode
* @see ReadDID
*/
@@ -48,8 +48,8 @@ public class DIDResult extends RPCStruct { public static final String KEY_RESULT_CODE = "resultCode";
public static final String KEY_DATA = "data";
public static final String KEY_DID_LOCATION = "didLocation";
- /** Constructs a new DIDResult object indicated by the Hashtable<br>
- * parameter
+ /** <p>Constructs a new DIDResult object indicated by the Hashtable
+ * parameter</p>
* @param hash
* The hash table to use
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java index 2d4badf7f..e8ff471d8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DTC.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* String containing hexadecimal identifier as well as other common names.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java index 61c3a0e90..635f85814 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteCommand.java @@ -7,13 +7,13 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Removes a command from the Command Menu.
- * <p>
- * <b>HMI Status Requirements:</b><br/>
- * HMILevel: FULL, LIMITED or BACKGROUND<br/>
- * AudioStreamingState: N/A<br/>
- * SystemContext: Should not be attempted when VRSESSION or MENU
- * </p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>HMI Status Requirements:</b></p>
+ * <p>HMILevel: FULL, LIMITED or BACKGROUND</p>
+ * AudioStreamingState: N/A
+ * <p>SystemContext: Should not be attempted when VRSESSION or MENU</p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -25,29 +25,28 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
* <tr>
* <td>cmdID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>Unique ID that identifies the Command to be deleted from Command Menu</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value: 2000000000</td>
+ * <td>Min Value: 0;Max Value: 2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
*
- *<b> Response:</b><br>
+ *<p><b> Response:</b></p>
*
- * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,<br> this means a command was removed from the Command Menu successfully.
- * <p>
- *<b> Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * INVALID_ID<br>
- * IN_USER<br>
-
+ * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,this means a command was removed from the Command Menu successfully.
+ *
+ *<p><b> Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p> INVALID_ID</p>
+ * <p> IN_USER</p>
* @since SmartDeviceLink 1.0
* @see AddCommand
* @see AddSubMenu
@@ -65,7 +64,7 @@ public class DeleteCommand extends RPCRequest { /**
* Constructs a new DeleteCommand object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -88,8 +87,8 @@ public class DeleteCommand extends RPCRequest { *
* @param cmdID
* an Integer value representing Command ID
- * <p>
- * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ *
+ * <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
*/
public void setCmdID( Integer cmdID ) {
if (cmdID != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java index 649792f17..4d35c6fd3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteFile.java @@ -8,8 +8,8 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Used to delete a file resident on the SDL module in the app's local cache.
* Not supported on first generation SDL vehicles
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -28,17 +28,17 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * <p>
- * <b>Response </b><br>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
+ *
+ * <p><b>Response </b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
* @since SmartDeviceLink 2.0
* @see PutFile
* @see ListFiles
@@ -54,8 +54,8 @@ public class DeleteFile extends RPCRequest { }
/**
- * Constructs a new DeleteFile object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new DeleteFile object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java index 3694881ad..87f8cdbc3 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java @@ -10,17 +10,17 @@ import com.smartdevicelink.proxy.RPCRequest; * interactionChoiceSetID. If the specified interactionChoiceSetID is currently
* in use by an active <i> {@linkplain PerformInteraction}</i> this call to
* delete the Choice Set will fail returning an IN_USE resultCode
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b><br/>
- * </p>
- * AudioStreamingState: Any<br>
- * <p>
- * SystemContext: MAIN, MENU, VR
- * <p>
- * <p><b>Parameter List</b>
- * <p>
+ *
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
+ *
+ * <p>AudioStreamingState: Any</p>
+ *
+ * <p>SystemContext: MAIN, MENU, VR </p>
+ *
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -32,27 +32,27 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
* <tr>
* <td>interactionChoiceSetID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td> A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet)</td>
* <td>Y</td>
- * <td>Min Value: 0 <br>Max Value: 2000000000</td>
+ * <td>Min Value: 0 ; Max Value: 2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- *<p>
- * <b>Response </b><br>
- * <p>
- * If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application.<br>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * INVALID_ID<br>
+ *
+ * <p><b>Response </b></p>
+ *
+ * If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application.
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>INVALID_ID</p>
* @since SmartDeviceLink 1.0
* @see CreateInteractionChoiceSet
@@ -68,9 +68,9 @@ public class DeleteInteractionChoiceSet extends RPCRequest { super(FunctionID.DELETE_INTERACTION_CHOICE_SET.toString());
}
/**
- * Constructs a new DeleteInteractionChoiceSet object indicated by the
- * Hashtable parameter
- * <p>
+ * <p>Constructs a new DeleteInteractionChoiceSet object indicated by the
+ * Hashtable parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -88,8 +88,7 @@ public class DeleteInteractionChoiceSet extends RPCRequest { /**
* Sets a unique ID that identifies the Choice Set
* @param interactionChoiceSetID a unique ID that identifies the Choice Set
- * <p>
- * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ * <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000 </p>
*/
public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {
if (interactionChoiceSetID != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java index 1774ea2f9..aac605f51 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java @@ -7,14 +7,14 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Deletes a submenu from the Command Menu.
- * <p>
- * <b>Notes: </b>When an app deletes a submenu that has child commands, those
- * child commands are also deleted
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
*
- * <p><b>Parameter List</b>
+ * <p><b>Notes: </b>When an app deletes a submenu that has child commands, those
+ * child commands are also deleted</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -26,26 +26,26 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
* <tr>
* <td>menuID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>Unique ID that identifies the SubMenu to be delete</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value: 2000000000</td>
+ * <td>Min Value: 0; Max Value: 2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- *<p>
- * <b>Response </b><br>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * INVALID_ID<br>
- * IN_USE <br>
+ *
+ *<p> <b>Response </b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ *<p>SUCCESS</p>
+ *<p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> INVALID_ID</p>
+ * <p> IN_USE </p>
*
* @since SmartDeviceLink 1.0
* @see AddCommand
@@ -61,7 +61,7 @@ public class DeleteSubMenu extends RPCRequest { super(FunctionID.DELETE_SUB_MENU.toString());
}
/**
- * Constructs a new DeleteSubMenu object indicated by the Hashtable parameter<p>
+ * Constructs a new DeleteSubMenu object indicated by the Hashtable parameter
* @param hash The Hashtable to use
*/
public DeleteSubMenu(Hashtable<String, Object> hash) {
@@ -77,8 +77,8 @@ public class DeleteSubMenu extends RPCRequest { /**
* Sets the MenuID that identifies the SubMenu to be delete
* @param menuID an Integer value representing menuID that identifies the SubMenu to be delete
- * <p>
- * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ *
+ * <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
*/
public void setMenuID( Integer menuID ) {
if (menuID != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java index c2b061190..3d13f4354 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceInfo.java @@ -5,11 +5,11 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
/**
* Various information about connecting device.
- * <p>
- * <p>
*
- * <p><b>Parameter List</b>
- * <p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -64,7 +64,7 @@ import com.smartdevicelink.proxy.RPCStruct; * <td>Integer</td>
* <td>Omitted if connected not via BT.</td>
* <td>N</td>
- * <td>Min Value: 0<br>Max Value: 100</td>
+ * <td>Min Value: 0; Max Value: 100</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* </table>
@@ -77,7 +77,7 @@ public class DeviceInfo extends RPCStruct{ public static final String KEY_OS_VERSION = "osVersion";
public static final String KEY_CARRIER = "carrier";
public static final String KEY_MAX_NUMBER_RFCOMM_PORTS = "maxNumberRFCOMMPorts";
- /** Constructs a new DeviceInfo object indicated by the Hashtable<br>
+ /** Constructs a new DeviceInfo object indicated by the Hashtable
* parameter
* @param hash
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java index 2f9903be8..51d5304b4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DeviceStatus.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource; /**
* Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -95,7 +95,7 @@ import com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource; * </tr>
* </table>
* @since SmartDeviceLink 2.0
- * <p>
+ *
* @see DeviceLevelStatus
* @see GetVehicleData
* @see OnVehicleData
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java index 4bbeacb1a..0a0d8f997 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java @@ -7,7 +7,7 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/** Non periodic vehicle diagnostic request.
*
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -22,7 +22,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Name of target ECU.</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value: 65535</td>
+ * <td>Min Value: 0; Max Value: 65535</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* <tr>
@@ -30,23 +30,22 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Length of message (in bytes).</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value:65535</td>
+ * <td>Min Value: 0; Max Value:65535</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
-
* <tr>
* <td>messageData</td>
* <td>Integer</td>
* <td>Array of bytes comprising CAN message.</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value:255<br> Min Size:1<br> Max Size:65535<br> </td>
+ * <td>Min Value: 0; Max Value:255; Min Size:1; Max Size:65535</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* </table>
- * <b>HMI must:</b> <br>
- * <p>
- * 1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.
- * <p> 2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.
+ * <p><b>HMI must:</b> </p>
+ *
+ * <p>1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.</p>
+ * <p> 2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.</p>
* @since SmartDeviceLink 3.0
*
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java index 76fbc02d1..4651e1f20 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DialNumber.java @@ -28,7 +28,7 @@ public class DialNumber extends RPCRequest { * @param number * a phone number is a string, which can be up to 40 chars. * <p> - * <b>Notes: </b>Maxlength=40<p> + * <b>Notes: </b>Maxlength=40</p> * All characters shall be stripped from string except digits 0-9 and * # , ; + */ public void setNumber(String number) { diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java index e6b17cf24..f0739e371 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java @@ -10,7 +10,7 @@ import com.smartdevicelink.proxy.rpc.enums.MediaClockFormat; import com.smartdevicelink.util.DebugTool;
/**
* Contains information about the display for the SDL system to which the application is currently connected.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java index 54ec57a2a..88eb89e03 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ECallInfo.java @@ -6,8 +6,8 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.ECallConfirmationStatus;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataNotificationStatus;
/** Emergency Call notification and confirmation data.
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -17,7 +17,7 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataNotificationStatus; * <th>Notes</th>
* <th>Version Available</th>
* </tr>
-* <tr>
+ * <tr>
* <td>eCallNotificationStatus</td>
* <td>VehicleDataNotificationStatus</td>
* <td>References signal "eCallNotification_4A".</td>
@@ -25,7 +25,7 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataNotificationStatus; * <td></td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
-* <tr>
+ * <tr>
* <td>auxECallNotificationStatus</td>
* <td>VehicleDataNotificationStatus</td>
* <td>References signal "eCallNotification". This is an alternative signal available on some carlines replacing the eCallNotificationStatus, but showing the same values.</td>
@@ -55,11 +55,11 @@ public class ECallInfo extends RPCStruct { public static final String KEY_E_CALL_NOTIFICATION_STATUS = "eCallNotificationStatus";
public static final String KEY_AUX_E_CALL_NOTIFICATION_STATUS = "auxECallNotificationStatus";
public static final String KEY_E_CALL_CONFIRMATION_STATUS = "eCallConfirmationStatus";
- /** Constructs a new ECallInfo object indicated by the Hashtable<br>
+ /** Constructs a new ECallInfo object indicated by the Hashtable
* parameter
* @param hash
- * <p>
- * The hash table to use
+ *
+ * <p>The hash table to use</p>
*/
public ECallInfo() { }
public ECallInfo(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java index b3a5bccfb..5e1f2ede1 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EmergencyEvent.java @@ -7,8 +7,8 @@ import com.smartdevicelink.proxy.rpc.enums.EmergencyEventType; import com.smartdevicelink.proxy.rpc.enums.FuelCutoffStatus;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus;
/** Information related to an emergency event (and if it occurred).
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -47,7 +47,7 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataEventStatus; * <td>Integer</td>
* <td></td>
* <td>References signal "VedsMaxDeltaV_D_Ltchd".</td>
- * <td>minvalue=0<br> maxvalue=255<br> Additional reserved values:<br> 0x00 No event<br> 0xFE Not supported<br>0xFF Fault </td>
+ * <td>minvalue=0; maxvalue=255;<p> Additional reserved values:</p> <p>0x00 No event; 0xFE Not supported; 0xFF Fault</p> </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
@@ -75,11 +75,11 @@ public class EmergencyEvent extends RPCStruct { public static final String KEY_MAXIMUM_CHANGE_VELOCITY = "maximumChangeVelocity";
public static final String KEY_MULTIPLE_EVENTS = "multipleEvents";
- /** Constructs a new EmergencyEvent object indicated by the Hashtable<br>
+ /** Constructs a new EmergencyEvent object indicated by the Hashtable
* parameter
* @param hash
- * <p>
- * The hash table to use
+ *
+ * <p>The hash table to use</p>
*/
public EmergencyEvent() { }
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java index 65c0002b7..ab61c548e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/EndAudioPassThru.java @@ -7,26 +7,24 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* When this request is invoked, the audio capture stops
- * <p>
- * Function Group: AudioPassThru
- * <p>
+ *
+ * <p>Function Group: AudioPassThru</p>
+ *
* <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <b>Request</b><br>
-
-No parameters.<br><p>
-<b>Response</b> <br>
-<b>Non-default Result Codes:</b><br>
- - SUCCESS<br>
- - INVALID_DATA<br>
- - OUT_OF_MEMORY<br>
- - TOO_MANY_PENDING_REQUESTS<br>
- - APPLICATION_NOT_REGISTERED<br>
- - GENERIC_ERROR <br>
- - REJECTED<br>
- - DISALLOWED <br>
-<p>
-
+ *
+ * <p><b>Request</b></p>
+ *
+ * <p>No parameters.</p>
+ * <p><b>Response</b> </p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED</p>
* @since SmartDeviceLink 2.0
* @see PerformAudioPassThru
*/
@@ -40,9 +38,9 @@ public class EndAudioPassThru extends RPCRequest { }
/**
- * Constructs a new EndAudioPassThru object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new EndAudioPassThru object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java index 5173e531c..d76b11355 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GPSData.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.enums.Dimension; import com.smartdevicelink.util.SdlDataTypeConverter;
/**
* Describes the GPS data. Not all data will be available on all carlines.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -115,9 +115,9 @@ import com.smartdevicelink.util.SdlDataTypeConverter; * <td>altitude</td>
* <td>Integer</td>
* <td>Altitude in meters
- * <b>Minvalue: -10000
- * <b>Maxvalue: 10000
- * </td>
+ * <b>Minvalue: -10000</b>
+ * <b>Maxvalue: 10000</b>
+ * <b>Note:</b> SYNC uses Mean Sea Level for calculating GPS. </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java index 93e08651d..4618fd857 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GenericResponse.java @@ -9,7 +9,7 @@ import com.smartdevicelink.proxy.RPCResponse; * Generic Response is sent, when the name of a received msg cannot be
* retrieved. Only used in case of an error. Currently, only resultCode
* INVALID_DATA is used.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java index fd49e9005..fa3ba1c01 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetDTCs.java @@ -8,12 +8,12 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* This RPC allows to request diagnostic module trouble codes from a certain
* vehicle module.
- * <p>
- * Function Group: ProprietaryData
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
- * <p><b>Parameter List</b>
+ *
+ *<p> Function Group: ProprietaryData</p>
+ *
+ *<p> <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -28,7 +28,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Name of ECU.</td>
* <td>Y</td>
- * <td>Min Value: 0<br>Max Value: 65535</td>
+ * <td>Min Value: 0; Max Value: 65535</td>
* <td>SmartDeviceLink 2.0 </td>
* </tr>
* <tr>
@@ -36,21 +36,22 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>DTC Mask Byte to be sent in diagnostic request to module.</td>
* <td>N</td>
- * <td>Min Value: 0<br>Max Value: 255</td>
+ * <td>Min Value: 0; Max Value: 255</td>
* <td>SmartDeviceLink 2.0 </td>
* </tr>
* </table>
- * <b>Response</b><br>
- * <p>
- * <b>Non-default Result Codes:</b><br>-
- * SUCCESS<br>-
- * INVALID_DATA<br>- OUT_OF_MEMORY<br>-
- * TOO_MANY_PENDING_REQUESTS<br>
- * - APPLICATION_NOT_REGISTERED<br>
- * - GENERIC_ERROR<br>
- * - REJECTED<br>
- * - DISALLOWED <br>
- * - USER_DISALLOWED<br>
+ * <p><b>Response</b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ *<p> SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ *<p> OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ *<p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED </p>
+ * <p>USER_DISALLOWED</p>
* @since SmartDeviceLink 2.0
*/
public class GetDTCs extends RPCRequest {
@@ -65,8 +66,8 @@ public class GetDTCs extends RPCRequest { }
/**
- * Constructs a new GetDTCs object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new GetDTCs object indicated by the Hashtable parameter
+ * </p>
*
* @param hash
* The Hashtable to use
@@ -82,7 +83,7 @@ public class GetDTCs extends RPCRequest { * an Integer value representing a name of the module to receive
* the DTC form
* <p>
- * <b>Notes: </b>Minvalue:0; Maxvalue:65535
+ * <b>Notes:</p> </b>Minvalue:0; Maxvalue:65535
*/
public void setEcuName(Integer ecuName) {
if (ecuName != null) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java index 100c6bf50..0c15c02c9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/GetVehicleData.java @@ -6,8 +6,8 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
* Non periodic vehicle data read request.
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -178,21 +178,21 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * <p>
*
- * <b>Response</b>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * VEHICLE_DATA_NOT_ALLOWED<br>
- * VEHICLE_DATA_NOT_AVAILABLE<br>
- * USER_DISALLOWED<br>
+ *
+ * <p><b>Response</b></p>
+ *
+ * <p> <b>Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> VEHICLE_DATA_NOT_ALLOWED</p>
+ * <p>VEHICLE_DATA_NOT_AVAILABLE</p>
+ * <p> USER_DISALLOWED</p>
*
* @see SubscribeVehicleData
* @see UnSubscribeVehicleData
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java index bf9f6ca59..d8223279a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HMIPermissions.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.HMILevel;
/**
* Defining sets of HMI levels, which are permitted or prohibited for a given RPC.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java index ff79998b4..46a982fe2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/HeadLampStatus.java @@ -5,8 +5,8 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.AmbientLightStatus;
/** Status of the head lamps.
- * <p>
- * <table border="1" rules="all">
+ *
+ * <p><table border="1" rules="all"></p>
* <tr>
* <th>Param Name</th>
* <th>Type</th>
@@ -44,8 +44,8 @@ public class HeadLampStatus extends RPCStruct { public static final String KEY_AMBIENT_LIGHT_SENSOR_STATUS = "ambientLightSensorStatus";
public static final String KEY_HIGH_BEAMS_ON = "highBeamsOn";
public static final String KEY_LOW_BEAMS_ON = "lowBeamsOn";
- /** Constructs a new HeadLampStatus object indicated by the Hashtable<br>
- * parameter
+ /**<p> Constructs a new HeadLampStatus object indicated by the Hashtable
+ * parameter</p>
* @param hash
* The hash table to use
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java index b24b6ec2c..76ad2d224 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Image.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.rpc.enums.ImageType; /**
*Specifies, which image shall be used, e.g. in Alerts or on Softbuttons provided the display supports it.
- *<p><b>Parameter List</b>
+ *<p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java index b2bb6304e..9e38dc264 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageField.java @@ -10,7 +10,7 @@ import com.smartdevicelink.proxy.rpc.enums.ImageFieldName; import com.smartdevicelink.util.DebugTool;
/** <p>The name that identifies the field.For example AppIcon,SoftButton, LocationImage, etc.</p>
*
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java index 149b12386..682092082 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ImageResolution.java @@ -5,8 +5,8 @@ import com.smartdevicelink.proxy.RPCStruct; import java.util.Hashtable;
/** The image resolution of this field.
*
- * <p><b>Parameter List</b>
- * <p>
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -21,7 +21,7 @@ import java.util.Hashtable; * <td>Integer</td>
* <td>The image resolution width.</td>
* <td></td>
- * <td>minvalue:1<br> maxvalue: 10000</td>
+ * <td>minvalue:1; maxvalue: 10000</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* <tr>
@@ -29,10 +29,10 @@ import java.util.Hashtable; * <td>Integer</td>
* <td>The image resolution height.</td>
* <td></td>
- * <td>minvalue:1<br> maxvalue: 10000</td>
+ * <td>minvalue:1; maxvalue: 10000</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
- * </tr>
+ *
* </table>
* @since SmartDeviceLink 3.0
* @see DisplayType
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java index 0d784016b..fb35dcf24 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/KeyboardProperties.java @@ -8,8 +8,8 @@ import com.smartdevicelink.proxy.rpc.enums.KeyboardLayout; import com.smartdevicelink.proxy.rpc.enums.KeypressMode;
import com.smartdevicelink.proxy.rpc.enums.Language;
/** This mode causes the interaction to immediately display a keyboard entry through the HMI.
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java index 83629a0de..faeaa7977 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ListFiles.java @@ -8,23 +8,19 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Requests the current list of resident filenames for the registered app. Not
* supported on First generation SDL vehicles.
- * <p>
- * <b>Request</b><br>
-No parameters.<br>
-<p>
-<b>Response:</b><br>
-Returns the current list of resident filenames for the registered app along with the current space available.
-<p>
-
-<b>Non-default Result Codes:</b><br>
- - SUCCESS<br>
- - INVALID_DATA<br>
- - OUT_OF_MEMORY<br>
- - TOO_MANY_PENDING_REQUESTS<br>
- - APPLICATION_NOT_REGISTERED<br>
- - GENERIC_ERROR <br>
- - REJECTED<br>
-
+ *
+ * <p><b>Request</b></p>
+ * <p>No parameters.</p>
+ * <p><b>Response:</b></p>
+ * Returns the current list of resident filenames for the registered app along with the current space available.
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>REJECTED</p>
* @since SmartDeviceLink 2.0
*/
public class ListFiles extends RPCRequest {
@@ -37,8 +33,8 @@ public class ListFiles extends RPCRequest { }
/**
- * Constructs a new ListFiles object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new ListFiles object indicated by the Hashtable parameter
+ * </p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java index 4d8fd494c..a9f22238a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MenuParams.java @@ -5,7 +5,7 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
/**
* Used when adding a sub menu to an application menu or existing sub menu.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -15,7 +15,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>parentID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>The unique ID of an existing submenu to which a command will be added.
* If this element is not provided, the command will be added to the top level of the Command Menu.
* <ul>
@@ -27,7 +27,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>position</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>Position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
* Position of any submenu will always be located before the return and exit options.
* <ul>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java index 416d956c9..4936f9fec 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/MyKey.java @@ -5,7 +5,7 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataStatus;
/** Information related to the MyKey feature.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -22,7 +22,7 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataStatus; * </table>
*
*@since SmartDeviceLink 2.0
- *<p>
+ *
*@see GetVehicleData
*@see OnVehicleData
*@see VehicleDataStatus
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java index 21cb9bc52..af155226e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java @@ -20,7 +20,7 @@ import com.smartdevicelink.proxy.rpc.enums.AppInterfaceUnregisteredReason; * SystemContext:
* <ul><li>Any</li></ul>
* </ul>
- * <p>
+ * <p></p>
* <b>Parameter List:</b>
* <table border="1" rules="all">
* <tr>
@@ -36,7 +36,6 @@ import com.smartdevicelink.proxy.rpc.enums.AppInterfaceUnregisteredReason; * <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- * </p>
* @since SmartDeviceLink 1.0
* @see RegisterAppInterface
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java index ced92707f..7f9afb627 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnButtonEvent.java @@ -9,7 +9,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; /**
* Notifies application that user has depressed or released a button to which
- * the application has subscribed.</br> Further information about button events
+ * the application has subscribed.Further information about button events
* and button-presses can be found at {@linkplain SubscribeButton}.
* <p>
* </p>
@@ -36,7 +36,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * button will cancel VR.</li>
* </ul>
* </ul>
- * <p>
+ * <p></p>
* <b>Parameter List:</b>
* <table border="1" rules="all">
* <tr>
@@ -73,7 +73,7 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * </p>
+ * <p></p>
*
* @since SmartDeviceLink 1.0
*
@@ -142,7 +142,7 @@ public class OnButtonEvent extends RPCNotification { return null;
}
/**
- * <p> Set the event mode of the button,pressed or released
+ * <p> Set the event mode of the button,pressed or released</p>
* @param buttonEventMode indicates the button is pressed or released
* @see ButtonEventMode
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java index 77632b8b2..eae7e77f8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnCommand.java @@ -32,7 +32,7 @@ import com.smartdevicelink.proxy.rpc.enums.TriggerSource; * </tr>
* <tr>
* <td>cmdID</td>
- * <td>Int32</td>
+ * <td>Integer</td>
* <td>The cmdID of the command the user selected. This is the cmdID value provided by the application in the AddCommand operation that created the command.</td>
* <td></td>
* <td>SmartDeviceLink 1.0</td>
@@ -99,8 +99,8 @@ public class OnCommand extends RPCNotification { return null;
}
/**
- * <p>Sets TriggerSource<br/>
- * Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
+ * <p>Sets TriggerSource</p>
+ * <p>Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
* @param triggerSource a TriggerSource object
*/
public void setTriggerSource( TriggerSource triggerSource ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java index b73c0e877..776d69e4a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnHashChange.java @@ -5,10 +5,10 @@ import java.util.Hashtable; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCNotification;
/**
- * Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.).<br>
+ * Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.).
* Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.
- * <p>
- * <p><b>Parameter List</b>
+ * <p></p>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java index 2794333bc..e71cda0a8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java @@ -8,8 +8,8 @@ import com.smartdevicelink.proxy.rpc.enums.KeyboardEvent; /**
* On-screen keyboard event. Can be full string or individual keypresses depending on keyboard mode.
- * <p>
- * <p><b>Parameter List</b>
+ * <p></p>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -30,12 +30,12 @@ import com.smartdevicelink.proxy.rpc.enums.KeyboardEvent; * <tr>
* <td>data</td>
* <td>String</td>
- * <td>On-screen keyboard input data.<br>For dynamic keypress events, this will be the current compounded string of entry text.<br>For entry cancelled and entry aborted events, this data param will be omitted.</td>
+ * <td>On-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted.</td>
* <td></td>
* <td>Maxlength: 500</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
- * </tr>
+ *
* </table>
*
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java index fca7e6266..11f6469ef 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnLockScreenStatus.java @@ -10,8 +10,6 @@ import com.smartdevicelink.proxy.rpc.OnHMIStatus; * Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.
* For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.
* The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.
->>>>>>> theirs -
*
*
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java index 7776a6916..aaa3b2483 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnSystemRequest.java @@ -15,9 +15,9 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.FileType;
import com.smartdevicelink.proxy.rpc.enums.RequestType;
/**
- * An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud<br>Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)
- * <p>
- * <p><b>Parameter List</b>
+ * An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud. Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -38,17 +38,17 @@ import com.smartdevicelink.proxy.rpc.enums.RequestType; * <tr>
* <td>url</td>
* <td>Array of Strings</td>
- * <td>Optional URL for HTTP requests.<br>If blank, the binary data shall be forwarded to the app.<br>If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</td>
+ * <td>Optional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</td>
* <td>N</td>
- * <td>maxlength: 1000 <br>minsize:1<br> maxsize: 100</td>
+ * <td>maxlength: 1000; minsize:1; maxsize: 100</td>
* <td>SmartDeviceLink 2.3.2 </td>
* </tr>
* <tr>
* <td>timeout</td>
* <td>Integer</td>
- * <td>Optional timeout for HTTP requests<br>Required if a URL is provided</td>
+ * <td>Optional timeout for HTTP requests;Required if a URL is provided</td>
* <td>N</td>
- * <td>minvalue:0<br> maxvalue: 2000000000</td>
+ * <td>minvalue:0; maxvalue: 2000000000</td>
* <td>SmartDeviceLink </td>
* </tr>
* <tr>
@@ -64,7 +64,7 @@ import com.smartdevicelink.proxy.rpc.enums.RequestType; * <td>Float</td>
* <td>Optional offset in bytes for resuming partial data chunks</td>
* <td>N</td>
- * <td>minvalue:0<br> maxvalue:100000000000</td>
+ * <td>minvalue:0; maxvalue:100000000000</td>
* <td>SmartDeviceLink 2.3.2 </td>
* </tr>
* <tr>
@@ -72,7 +72,7 @@ import com.smartdevicelink.proxy.rpc.enums.RequestType; * <td>Float</td>
* <td>Optional length in bytes for resuming partial data chunks</td>
* <td>N</td>
- * <td>minvalue: 0<br> maxvalue:100000000000</td>
+ * <td>minvalue: 0; maxvalue:100000000000</td>
* <td>SmartDeviceLink 2.3.2 </td>
* </tr>
* </table>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java index 8e6969d95..bfb31d789 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnTouchEvent.java @@ -11,8 +11,8 @@ import com.smartdevicelink.proxy.rpc.enums.TouchType; /**
*
* Notifies about touch events on the screen's prescribed area.
- * <p><b>Parameter List</b>
- * <p>
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -35,14 +35,14 @@ import com.smartdevicelink.proxy.rpc.enums.TouchType; * <td>TouchEvent</td>
* <td>List of all individual touches involved in this event.</td>
* <td>Y</td>
- * <td>minsize:1<br> maxsize:10</td>
+ * <td>minsize:1; maxsize:10</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* </table>
- * <p>
- * <b>Note:</b>
- * SDL needs to be informed about every User`s touching the touch screen.
- * <p>
+ *
+ * <p><b>Note:</b></p>
+ * <p>SDL needs to be informed about every User`s touching the touch screen.</p>
+ *
*/
public class OnTouchEvent extends RPCNotification {
public static final String KEY_EVENT = "event";
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java index 37761045e..1a6baefef 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/OnVehicleData.java @@ -13,17 +13,17 @@ import com.smartdevicelink.util.SdlDataTypeConverter; /**
*Individual requested DID result and data.
*
- * <p>
- * Callback for the periodic and non periodic vehicle data read function.<br>
- * <p>
- * <b>Note:</b> <br>
- * <p>
- * Initially SDL sends SubscribeVehicleData for getting the periodic updates from HMI whenever each of subscribed data types changes.<br> OnVehicleData is expected to bring such updated values to SDL
+ *
+ * <p>Callback for the periodic and non periodic vehicle data read function.</p>
+ *
+ * <p> <b>Note:</b></p>
+ *
+ * Initially SDL sends SubscribeVehicleData for getting the periodic updates from HMI whenever each of subscribed data types changes. OnVehicleData is expected to bring such updated values to SDL
*
*
*
*
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -215,7 +215,7 @@ import com.smartdevicelink.util.SdlDataTypeConverter; * <td>Float</td>
* <td>Torque value for engine (in Nm) on non-diesel variants</td>
* <td>N</td>
- * <td>minvalue:-1000<br>maxvalue:2000</td>
+ * <td>minvalue:-1000; maxvalue:2000</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -223,7 +223,7 @@ import com.smartdevicelink.util.SdlDataTypeConverter; * <td>Float</td>
* <td>Accelerator pedal position (percentage depressed)</td>
* <td>N</td>
- * <td>minvalue: 0<br> maxvalue:100</td>
+ * <td>minvalue: 0; maxvalue:100</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -231,18 +231,16 @@ import com.smartdevicelink.util.SdlDataTypeConverter; * <td>Float</td>
* <td>Current angle of the steering wheel (in deg)</td>
* <td>N</td>
- * <td> minvalue: -2000<br>maxvalue:2000</td>
+ * <td> minvalue: -2000; maxvalue:2000</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
*
* @since SmartDeviceLink 1.0
- * <p>
+ *
* @see SubscribeVehicleData
* @see UnsubscribeVehicleData
*
->>>>>>> theirs -
*
*/
public class OnVehicleData extends RPCNotification {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java index 24ffdf4d8..996de27ac 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ParameterPermissions.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Defining sets of parameters, which are permitted or prohibited for a given RPC.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java index 67085ea7d..0e663f63d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java @@ -13,12 +13,12 @@ import com.smartdevicelink.proxy.rpc.enums.SamplingRate; /**
* This will open an audio pass thru session. By doing so the app can receive
* audio data through the vehicles microphone
- * <p>
- * Function Group: AudioPassThru
- * <p>
+ *
+ * <p>Function Group: AudioPassThru</p>
+ *
* <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -33,7 +33,7 @@ import com.smartdevicelink.proxy.rpc.enums.SamplingRate; * <td>TTSChunk[]</td>
* <td>SDL will speak this prompt before opening the audio pass thru session. </td>
* <td>N</td>
- * <td>This is an array of text chunks of type TTSChunk. The array must have at least one item If omitted, then no initial prompt is spoken: <br> Array Minsize: 1<br> Array Maxsize: 100</td>
+ * <td>This is an array of text chunks of type TTSChunk. The array must have at least one item If omitted, then no initial prompt is spoken: <p>Array Minsize: 1</p> Array Maxsize: 100</td>
* <td>SmartDeviceLink 2.0 </td>
* </tr>
* <tr>
@@ -57,7 +57,7 @@ import com.smartdevicelink.proxy.rpc.enums.SamplingRate; * <td>Integer</td>
* <td>The maximum duration of audio recording in milliseconds.</td>
* <td>Y</td>
- * <td>Minvalue: 1<br> Maxvalue: 1000000</td>
+ * <td>Minvalue: 1; Maxvalue: 1000000</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -90,7 +90,6 @@ import com.smartdevicelink.proxy.rpc.enums.SamplingRate; *
*
* </table>
-
* @since SmartDeviceLink 2.0
* @see EndAudioPassThru
*/
@@ -112,9 +111,9 @@ public class PerformAudioPassThru extends RPCRequest { }
/**
- * Constructs a new PerformAudioPassThru object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new PerformAudioPassThru object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
@@ -131,7 +130,7 @@ public class PerformAudioPassThru extends RPCRequest { * a List<TTSChunk> value represents the initial prompt which
* will be spoken before opening the audio pass thru session by
* SDL
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>This is an array of text chunks of type TTSChunk</li>
@@ -181,9 +180,9 @@ public class PerformAudioPassThru extends RPCRequest { * Sets a line of text displayed during audio capture
*
* @param audioPassThruDisplayText1
- * a String value representing the line of text displayed during
- * audio capture
- * <p>
+ * <p>a String value representing the line of text displayed during
+ * audio capture</p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setAudioPassThruDisplayText1(String audioPassThruDisplayText1) {
@@ -208,9 +207,9 @@ public class PerformAudioPassThru extends RPCRequest { * Sets a line of text displayed during audio capture
*
* @param audioPassThruDisplayText2
- * a String value representing the line of text displayed during
- * audio capture
- * <p>
+ * <p>a String value representing the line of text displayed during
+ * audio capture</p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setAudioPassThruDisplayText2(String audioPassThruDisplayText2) {
@@ -266,7 +265,7 @@ public class PerformAudioPassThru extends RPCRequest { * @param maxDuration
* an Integer value representing the maximum duration of audio
* recording in millisecond
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue:1; Maxvalue:1000000
*/
public void setMaxDuration(Integer maxDuration) {
@@ -346,8 +345,8 @@ public class PerformAudioPassThru extends RPCRequest { }
/**
- * Gets a Boolean value representing if the current audio source should be
- * muted during the APT session<br/>
+ *<p> Gets a Boolean value representing if the current audio source should be
+ * muted during the APT session</p>
*
*
* @return Boolean -a Boolean value representing if the current audio source
@@ -358,11 +357,11 @@ public class PerformAudioPassThru extends RPCRequest { }
/**
- * Sets a muteAudio value representing if the current audio source should be
- * muted during the APT session<br/>
+ * <p>Sets a muteAudio value representing if the current audio source should be
+ * muted during the APT session
* If not, the audio source will play without interruption. If omitted, the
- * value is set to true
- * <p>
+ * value is set to true</p>
+ *
*
* @param muteAudio
* a Boolean value representing if the current audio source
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java index 7ba905f96..2e90356ed 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformAudioPassThruResponse.java @@ -20,9 +20,9 @@ public class PerformAudioPassThruResponse extends RPCResponse { }
/**
- * Constructs a new PerformAudioPassThruResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new PerformAudioPassThruResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java index fc4154a2c..9ad8c1034 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteraction.java @@ -14,12 +14,12 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * application may use a PerformInteraction to ask a user to say the name of a
* song to play. The user's response is only valid if it appears in the
* specified Choice Sets and is recognized by SDL
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL</b>
- * </p>
- * <p><b>Parameter List</b>
+ * <p></p>
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel needs to be FULL</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -42,7 +42,7 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * <td>TTSChunk</td>
* <td>An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.</td>
* <td>Y</td>
- * <td>minsize:1<br>maxsize:100</td>
+ * <td>minsize:1; maxsize:100</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -58,23 +58,23 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * <td>Integer</td>
* <td>Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.</td>
* <td>Y</td>
- * <td>minsize:0<br>maxsize:100<br>minvalue:0<br>maxvalue:2000000000</td>
+ * <td>minsize:0; maxsize:100; minvalue:0; maxvalue:2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>helpPrompt</td>
* <td>TTSChunk</td>
- * <td>An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. <br>If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. </td>
+ * <td>An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. </td>
* <td>N</td>
- * <td>minsize:1<br>maxsize:100<br><p><p>The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.</td>
+ * <td>minsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>timeoutPrompt</td>
* <td>TTSChunk</td>
- * <td>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. <br>If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). </td>
+ * <td>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). </td>
* <td>N</td>
- * <td>The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. <br>minsize:1<br>maxsize:100</td>
+ * <td>The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -82,7 +82,7 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * <td>Integer</td>
* <td>The amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.</td>
* <td>N</td>
- * <td>minvalue:5000<br>maxvalue:100000<br>defvalue:10000</td>
+ * <td>minvalue:5000; maxvalue:100000; defvalue:10000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -90,7 +90,7 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * <td>VrHelpItem</td>
* <td>Ability to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.</td>
* <td>N</td>
- * <td>Min = 1<br>Max = 100</td>
+ * <td>Min = 1;Max = 100</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -102,7 +102,7 @@ import com.smartdevicelink.proxy.rpc.enums.LayoutMode; * <td>SmartDeviceLink 3.0</td>
* </tr>
* </table>
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
* @see CreateInteractionChoiceSet
@@ -127,7 +127,7 @@ public class PerformInteraction extends RPCRequest { /**
* Constructs a new PerformInteraction object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -265,7 +265,7 @@ public class PerformInteraction extends RPCRequest { * -a List<Integer> representing an Array of one or more Choice
* Set IDs. User can select any choice from any of the specified
* Choice Sets
- * <p>
+ * <p></p>
* <b>Notes: </b>Min Value: 0; Max Vlaue: 2000000000
*/
public void setInteractionChoiceSetIDList(List<Integer> interactionChoiceSetIDList) {
@@ -305,11 +305,11 @@ public class PerformInteraction extends RPCRequest { /**
* Sets An array of TTSChunks which, taken together, specify the help phrase
* to be spoken when the user says "help" during the VR session
- * <p>
+ * <p></p>
* If this parameter is omitted, the help prompt will be constructed by SDL
* from the first vrCommand of each choice of all the Choice Sets specified
* in the interactionChoiceSetIDList parameter
- * <P>
+ * <P></p>
* <b>Notes: </b>The helpPrompt specified in
* {@linkplain SetGlobalProperties} is not used by PerformInteraction
*
@@ -354,7 +354,7 @@ public class PerformInteraction extends RPCRequest { /**
* Sets An array of TTSChunks which, taken together, specify the phrase to
* be spoken when the listen times out during the VR session
- * <p>
+ * <p></p>
* <b>Notes: </b>The timeoutPrompt specified in
* {@linkplain SetGlobalProperties} is not used by PerformInteraction
*
@@ -393,7 +393,7 @@ public class PerformInteraction extends RPCRequest { * an Integer value representing the amount of time, in
* milliseconds, SDL will wait for the user to make a choice (VR
* or Menu)
- * <p>
+ * <p></p>
* <b>Notes: </b>Min Value: 5000; Max Value: 100000
*/
public void setTimeout(Integer timeout) {
@@ -436,10 +436,10 @@ public class PerformInteraction extends RPCRequest { *
* @param vrHelp
* a List representing a suggested VR Help Items to display
- * on-screen during Perform Interaction<br/>
+ * on-screen during Perform Interaction
* If omitted on supported displays, the default SDL generated
* list of suggested choices will be displayed
- * <p>
+ * <p></p>
* <b>Notes: </b>Min=1; Max=100
* @since SmartDeviceLink 2.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java index c0c212a85..c2b56dcd0 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java @@ -26,7 +26,7 @@ public class PerformInteractionResponse extends RPCResponse { /**
* Constructs a new PerformInteractionResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -66,7 +66,7 @@ public class PerformInteractionResponse extends RPCResponse { return null;
}
/**
- * <p>Sets TriggerSource<br/>
+ * <p>Sets TriggerSource
* Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
* @param triggerSource a TriggerSource object
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java index 9ce6e3921..7776c12b7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PermissionItem.java @@ -6,9 +6,9 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.util.DebugTool;
/**
- * Change in permissions for a given set of RPCs<br>
+ * Change in permissions for a given set of RPCs
*
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java index 65af39c11..df28213c7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Contains information about on-screen preset capabilities.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java index f0a38af9d..d3997deec 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFile.java @@ -9,9 +9,9 @@ import com.smartdevicelink.proxy.rpc.enums.FileType; /**
* Used to push a binary data onto the SDL module from a mobile device, such as
* icons and album art.
- * <p>
- * <b> Parameter List</b>
- * <p>
+ *
+ * <p><b> Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -40,7 +40,7 @@ import com.smartdevicelink.proxy.rpc.enums.FileType; * <tr>
* <td>persistentFile</td>
* <td>Boolean</td>
- * <td>Indicates if the file is meant to persist between sessions / ignition cycles.<br> If set to TRUE,then the system will aim to persist this file through session / cycles.<br>While files with this designation will have priority over others,<br> they are subject to deletion by the system at any time.<br> In the event of automatic deletion by the system,<br> the app will receive a rejection and have to resend the file.<br> If omitted, the value will be set to false.</td>
+ * <td>Indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.</td>
* <td>N</td>
* <td></td>
* <td>SmartDeviceLink 2.0</td>
@@ -58,7 +58,7 @@ import com.smartdevicelink.proxy.rpc.enums.FileType; * <td>Float</td>
* <td>Optional offset in bytes for resuming partial data chunks</td>
* <td>N</td>
- * <td>Minvalue=0 <br>Maxvalue=100000000000</td>
+ * <td>Minvalue=0; Maxvalue=100000000000</td>
* <td>SmartDeviceLink 2.3.2</td>
* </tr>
* <tr>
@@ -66,26 +66,26 @@ import com.smartdevicelink.proxy.rpc.enums.FileType; * <td>Float</td>
* <td>Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded</td>
* <td>N</td>
- * <td>Minvalue=0<br> Maxvalue=100000000000</td>
+ * <td>Minvalue=0; Maxvalue=100000000000</td>
* <td>SmartDeviceLink 2.3.2</td>
* </tr>
* </table>
- * <b>Note: </b><br>
- * When using PutFiles you may want to check for memory<br>
- * <p>
- * <b>Response</b> <br>
+ * <p> <b>Note: </b></p>
+ * When using PutFiles you may want to check for memory
+ *
+ * <p><b>Response</b> </p>
* Response is sent, when the file data was copied (success case). Or when an error occurred. Not supported on First generation SDL modules.
- * <p>
- * <b> Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- *<p>
- * <table border="1" rules="all">
+ *
+ * <p><b> Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ *
+ * <p><table border="1" rules="all"></p>
* <tr>
* <th>Name</th>
* <th>Type</th>
@@ -99,7 +99,7 @@ import com.smartdevicelink.proxy.rpc.enums.FileType; * <td>Integer</td>
* <td>Provides the total local space available on SDL for the registered app.</td>
* <td></td>
- * <td>Minvalue=0 <br>Maxvalue=2000000000</td>
+ * <td>Minvalue=0; Maxvalue=2000000000</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
@@ -126,7 +126,7 @@ public class PutFile extends RPCRequest { /**
* Constructs a new PutFile object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -140,7 +140,7 @@ public class PutFile extends RPCRequest { *
* @param sdlFileName
* a String value representing a file reference name
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setSdlFileName(String sdlFileName) {
@@ -197,7 +197,7 @@ public class PutFile extends RPCRequest { * by the system at any time. In the event of automatic deletion by the
* system, the app will receive a rejection and have to resend the file. If
* omitted, the value will be set to false
- * <p>
+ * <p></p>
*
* @param persistentFile
* a Boolean value
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java index 88c0560b3..b9195981b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/PutFileResponse.java @@ -23,7 +23,7 @@ public class PutFileResponse extends RPCResponse { /**
* Constructs a new PutFileResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java index b358d95ba..285416881 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ReadDID.java @@ -7,15 +7,15 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Non periodic vehicle data read request. This is an RPC to get diagnostics
+ * <p>Non periodic vehicle data read request. This is an RPC to get diagnostics
* data from certain vehicle modules. DIDs of a certain module might differ from
- * vehicle type to vehicle type
- * <p>
- * Function Group: ProprietaryData
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
- * <p><b>Parameter List</b>
+ * vehicle type to vehicle type</p>
+ *
+ * <p>Function Group: ProprietaryData</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -30,7 +30,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Name of ECU.</td>
* <td>Y</td>
- * <td>Minvalue: 0<br>Maxvalue: 65535</td>
+ * <td>Minvalue: 0; Maxvalue: 65535</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
@@ -39,7 +39,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Get raw data from vehicle data DID location(s).</td>
* <td>Y</td>
- * <td>Minvalue: 0<br>Maxvalue: 65535</td>
+ * <td>Minvalue: 0; Maxvalue: 65535</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <td>appID</td>
@@ -50,20 +50,20 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * <p>
- * <b>Response</b>
- * <p>
- * <b>Non-default Result Codes:</b><br>
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * DISALLOWED<br>
- * USER_DISALLOWED <br>
- * TRUNCATED_DATA<br>
+ *
+ * <p><b>Response</b></p>
+ *
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p> DISALLOWED</p>
+ * <p>USER_DISALLOWED </p>
+ * <p>TRUNCATED_DATA</p>
*
* @since SmartDeviceLink 2.0
*/
@@ -80,7 +80,7 @@ public class ReadDID extends RPCRequest { /**
* Constructs a new ReadDID object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -94,7 +94,7 @@ public class ReadDID extends RPCRequest { *
* @param ecuName
* an Integer value representing the ID of the vehicle module
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue:0; Maxvalue:65535
*/
public void setEcuName(Integer ecuName) {
@@ -121,7 +121,7 @@ public class ReadDID extends RPCRequest { * @param didLocation
* a List<Integer> value representing raw data from vehicle
* data DID location(s)
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Minvalue:0; Maxvalue:65535</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java index 21efd91be..99bcba01a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java @@ -18,14 +18,14 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * sending an <i> {@linkplain OnAppInterfaceUnregistered}</i> notification, or
* by loss of the underlying transport connection, or closing of the underlying
* message transmission protocol RPC session
- * <p>
+ * <p></p>
* Until the application receives its first <i>{@linkplain OnHMIStatus}</i>
* Notification, its HMI Status is assumed to be: <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.HMILevel}</i>=NONE, <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.AudioStreamingState}
* </i>=NOT_AUDIBLE, <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.SystemContext}</i>=MAIN
- * <p>
+ * <p></p>
* All SDL® resources which the application creates or uses (e.g. Choice
* Sets, Command Menu, etc.) are associated with the application's interface
* registration. Therefore, when the interface registration ends, the SDL®
@@ -36,9 +36,9 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * interface registration and re-creating its required SDL® resources. That
* is, SDL® resources created by (or on behalf of) an application do not
* persist beyond the life-span of the interface registration
- * <p>
+ * <p></p>
* Resources and settings whose lifespan is tied to the duration of an
- * application's interface registration:<br/>
+ * application's interface registration:
* <ul>
* <li>Choice Sets</li>
* <li>Command Menus (built by successive calls to <i>{@linkplain AddCommand}
@@ -47,13 +47,13 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <li>Media clock timer display value</li>
* <li>Media clock timer display value</li>
* </ul>
- * <p>
+ * <p></p>
* The autoActivateID is used to grant an application the HMILevel and
* AudioStreamingState it had when it last disconnected
- * <p>
+ * <p></p>
* <b>Notes: </b>The autoActivateID parameter, and associated behavior, is
* currently ignored by SDL®
- * <p>
+ * <p></p>
* When first calling this method (i.e. first time within life cycle of mobile
* app), an autoActivateID should not be included. After successfully
* registering an interface, an autoActivateID is returned to the mobile
@@ -62,20 +62,20 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * turned off while the application is running, the autoActivateID can then be
* passed in another call to RegisterAppInterface to re-acquire <i>
* {@linkplain com.smartdevicelink.proxy.rpc.enums.HMILevel}</i>=FULL
- * <p>
+ * <p></p>
* If the application intends to stream audio it is important to indicate so via
* the isMediaApp parameter. When set to true, audio will reliably stream
* without any configuration required by the user. When not set, audio may
* stream, depending on what the user might have manually configured as a media
* source on SDL®
- * <p>
+ * <p></p>
* There is no time limit for how long the autoActivateID is "valid" (i.e. would
* confer focus and opt-in)
- * <p>
- * <b>HMILevel is not defined before registering</b><br/>
- * </p>
*
- * <p><b>Parameter List</b>
+ *<p> <b>HMILevel is not defined before registering</b></p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -90,7 +90,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>MsgVersion</td>
* <td>Declares what version of the SDL interface the application expects to use with SDL</td>
* <td>Y</td>
- * <td>To be compatible, app msg major version number must be less than or equal to SDL major version number. <br>If msg versions are incompatible, app has 20 seconds to attempt successful RegisterAppInterface (w.r.t. msg version) on underlying protocol session, else will be terminated. <br>Major version number is a compatibility declaration. Minor version number indicates minor functional variations (e.g. features, capabilities, bug fixes) when sent from SDL to app (in RegisterAppInterface response).<br> However, the minor version number sent from the app to SDL (in RegisterAppInterface request) is ignored by SDL.</td>
+ * <td>To be compatible, app msg major version number must be less than or equal to SDL major version number. <p>If msg versions are incompatible, app has 20 seconds to attempt successful RegisterAppInterface (w.r.t. msg version) on underlying protocol session, else will be terminated. Major version number is a compatibility declaration. Minor version number indicates minor functional variations (e.g. features, capabilities, bug fixes) when sent from SDL to app (in RegisterAppInterface response).</p>However, the minor version number sent from the app to SDL (in RegisterAppInterface request) is ignored by SDL.</td>
* <td>SmartDeviceLink 1.0 </td>
* </tr>
* <tr>
@@ -98,7 +98,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>String</td>
* <td>The mobile application's name. This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SDL .</td>
* <td>Y</td>
- * <td>- Must be 1-100 characters in length.<br>- Must consist of following characters: <br>- May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application. </td>
+ * <td><p> Must be 1-100 characters in length. Must consist of following characters: </p><p>May not be the same (by case insensitive comparison) as the name or any synonym of any currently registered application.</p> </td>
* <td>SmartDeviceLink 1.0 </td>
* </tr>
* <tr>
@@ -106,7 +106,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>TTSChunk</td>
* <td>TTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.</td>
* <td>N</td>
- * <td>- Size must be 1-100<br>- Needs to be unique over all applications<br>- May not be empty.<br>- May not start with a new line character.</td>
+ * <td><p>Size must be 1-100 Needs to be unique over all applications. May not be empty.<p>May not start with a new line character.</p></td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -114,7 +114,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>String</td>
* <td>Provides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.</td>
* <td>N</td>
- * <td>- Must be 1-5 characters<br>- If not provided, value will be derived from appName truncated to 5 characters.</td>
+ * <td>- Must be 1-5 characters. If not provided, value will be derived from appName truncated to 5 characters.</td>
* <td>SmartDeviceLink 1.0 </td>
* </tr>
* <tr>
@@ -122,7 +122,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>String</td>
* <td>An array of 1-100 elements, each element containing a voice-recognition synonym by which this app can be called when being addressed in the mobile applications menu.</td>
* <td>N</td>
- * <td>- Each vr synonym is limited to 40 characters, and there can be 1-100 synonyms in array-<br> May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application.</td>
+ * <td>Each vr synonym is limited to 40 characters, and there can be 1-100 synonyms in array. May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application.</td>
* <td>SmartDeviceLink 1.0 </td>
* </tr>
* <tr>
@@ -138,7 +138,7 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>Language</td>
* <td>An enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).</td>
* <td>Y</td>
- * <td>- If the language indicated does not match the active language on SDL, the interface registration will be rejected.<br>- If the user changes the SDL language while this interface registration is active, the interface registration will be terminated. </td>
+ * <td>If the language indicated does not match the active language on SDL, the interface registration will be rejected.If the user changes the SDL language while this interface registration is active, the interface registration will be terminated. </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -154,13 +154,13 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>AppHMIType</td>
* <td>List of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populate</td>
* <td>N</td>
- * <td>Array Minsize: 1<br>Array Maxsize: 100</td>
+ * <td>Array Minsize: 1; Array Maxsize: 100</td>
* <td>SmartDeviceLink 2.0 </td>
* </tr>
* <tr>
* <td>hashID</td>
* <td>String</td>
- * <td>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).<br>This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece.<br>If omitted, then the previous state of an app's commands, etc. will not be restored.<br>When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). </td>
+ * <td>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored.When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). </td>
* <td>N</td>
* <td>maxlength:100</td>
* <td>SmartDeviceLink 2.3.1 </td>
@@ -181,9 +181,35 @@ import com.smartdevicelink.proxy.rpc.enums.Language; * <td>Maxlength: 100</td>
* <td>SmartDeviceLink 2.0 </td>
* </tr>
+ *
+ * <tr>
+ * <td>hmiCapabilities</td>
+ * <td>HMICapabilities</td>
+ * <td>Specifies the HMI capabilities.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2.2 </td>
+ * </tr>
+ *
+ * <tr>
+ * <td>sdlVersion</td>
+ * <td>String</td>
+ * <td>The SmartDeviceLink version.</td>
+ * <td>N</td>
+ * <td>Maxlength: 100</td>
+ * <td>SmartDeviceLink 2.3.2.2</td>
+ * </tr>
+ *
+ * <tr>
+ * <td>systemSoftwareVersion</td>
+ * <td>String</td>
+ * <td>The software version of the system that implements the SmartDeviceLink core.</td>
+ * <td>N</td>
+ * <td>Maxlength: 100</td>
+ * <td>SmartDeviceLink 2.3.2.2</td>
+ * </tr>
* </table>
- * <p>
-
+ * <p></p>
* @since SmartDeviceLink 1.0
* @see UnregisterAppInterface
* @see OnAppInterfaceUnregistered
@@ -210,7 +236,7 @@ public class RegisterAppInterface extends RPCRequest { /**
* Constructs a new RegisterAppInterface object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -240,7 +266,7 @@ public class RegisterAppInterface extends RPCRequest { * @param sdlMsgVersion
* a SdlMsgVersion object representing version of the SDL®
* SmartDeviceLink interface
- * <p>
+ * <p></p>
* <b>Notes: </b>To be compatible, app msg major version number
* must be less than or equal to SDL® major version number.
* If msg versions are incompatible, app has 20 seconds to
@@ -294,7 +320,7 @@ public class RegisterAppInterface extends RPCRequest { *
* @param appName
* a String value representing the Mobile Application's Name
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Must be 1-100 characters in length</li>
@@ -341,8 +367,8 @@ public class RegisterAppInterface extends RPCRequest { *
* @param ttsName
* a List<TTSChunk> value represeting the TTS Name
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>Size must be 1-100</li>
* <li>Needs to be unique over all applications</li>
@@ -381,7 +407,7 @@ public class RegisterAppInterface extends RPCRequest { * @param ngnMediaScreenAppName
* a String value representing an abbreviated version of the
* mobile applincation's name
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Must be 1-5 characters</li>
@@ -424,7 +450,7 @@ public class RegisterAppInterface extends RPCRequest { * @param vrSynonyms
* a List<String> value representing the an array of 1-100
* elements
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Each vr synonym is limited to 40 characters, and there can
@@ -485,7 +511,7 @@ public class RegisterAppInterface extends RPCRequest { *
* @param languageDesired
* a Language Enumeration
- * <p>
+ *
*
*/
public void setLanguageDesired(Language languageDesired) {
@@ -571,7 +597,7 @@ public class RegisterAppInterface extends RPCRequest { *
* @param appHMIType
* a List<AppHMIType>
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Array Minsize: = 1</li>
@@ -616,7 +642,7 @@ public class RegisterAppInterface extends RPCRequest { * @param appID
* a String value representing a unique ID, which an app will be
* given when approved
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength = 100
* @since SmartDeviceLink 2.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java index 05a96160c..f89e1a8b8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java @@ -80,7 +80,7 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * @param sdlMsgVersion
* a SdlMsgVersion object representing version of the SDL®
* SmartDeviceLink interface
- * <p>
+ * <p></p>
* <b>Notes: </b>To be compatible, app msg major version number
* must be less than or equal to SDL® major version number.
* If msg versions are incompatible, app has 20 seconds to
@@ -123,7 +123,7 @@ public class RegisterAppInterfaceResponse extends RPCResponse { *
* @param language
* a Language Enumeration
- * <p>
+ *
*
*/
public void setLanguage(Language language) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java index d273d73a2..4a9f18d7f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java @@ -10,17 +10,17 @@ import com.smartdevicelink.proxy.rpc.enums.GlobalProperty; /**
* Resets the passed global properties to their default values as defined by
* SDL
- * <p>
+ * <p></p>
* The HELPPROMPT global property default value is generated by SDL consists of
* the first vrCommand of each Command Menu item defined at the moment PTT is
- * pressed<br/>
- * The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
- * global property default value
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
+ * pressed
+ * <p>The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
+ * global property default value</p>
*
- * <p><b>Parameter List</b>
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -35,25 +35,25 @@ import com.smartdevicelink.proxy.rpc.enums.GlobalProperty; * <td>GlobalProperty</td>
* <td>An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.</td>
* <td>Y</td>
- * <td>Array must have at least one element.<br>minsize:1<br> maxsize:100</td>
+ * <td>Array must have at least one element.; minsize:1; maxsize:100</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
*
* </table>
- * <b>Response</b><br>
+ * <p><b>Response</b></p>
*
- * Indicates whether the Global Properties were successfully set to their default values.<br>
- * <p>
- * <b>Non-default Result Codes:</b><br>
+ * <p>Indicates whether the Global Properties were successfully set to their default values.</p>
*
- * SUCCESS<br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR <br>
- * REJECTED <br>
- * DISALLOWED <br>
+ * <p><b>Non-default Result Codes:</b></p>
+ *
+ * <p> SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR </p>
+ * <p> REJECTED </p>
+ * <p>DISALLOWED </p>
* @since SmartDeviceLink 1.0
* @see SetGlobalProperties
*/
@@ -68,7 +68,7 @@ public class ResetGlobalProperties extends RPCRequest { /**
* Constructs a new ResetGlobalProperties object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
@@ -114,7 +114,7 @@ public class ResetGlobalProperties extends RPCRequest { * a List<GlobalProperty> An array of one or more
* GlobalProperty enumeration elements indicating which global
* properties to reset to their default value
- * <p>
+ * <p></p>
* <b>Notes: </b>Array must have at least one element
*/
public void setProperties( List<GlobalProperty> properties ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java index 3390fb814..dec7cde94 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ResetGlobalPropertiesResponse.java @@ -22,7 +22,7 @@ public class ResetGlobalPropertiesResponse extends RPCResponse { /**
* Constructs a new ResetGlobalPropertiesResponse object indicated by the Hashtable
* parameter
- * <p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java index a092b7b14..fe2c626a0 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScreenParams.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.TouchEventCapabilities; import com.smartdevicelink.util.DebugTool;
/** The resolution of the prescribed screen area.
*
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java index 38d3e1404..2fae92ec5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessage.java @@ -10,12 +10,12 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Creates a full screen overlay containing a large block of formatted text that
* can be scrolled with up to 8 SoftButtons defined
- * <p>
- * Function Group: ScrollableMessage
- * <p>
- * <b>HMILevel needs to be FULL</b>
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p>Function Group: ScrollableMessage</p>
+ *
+ * <p><b>HMILevel needs to be FULL</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -38,7 +38,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</td>
* <td>N</td>
- * <td>minvalue=1000<br> maxvalue=65535<br> defvalue=30000</td>
+ * <td>minvalue=1000; maxvalue=65535; defvalue=30000</td>
* <td>SmartDevice Link 1.0 </td>
* </tr>
* <tr>
@@ -46,23 +46,23 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SoftButton</td>
* <td>App defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.</td>
* <td>N</td>
- * <td>minsize=0<br> maxsize=8</td>
+ * <td>minsize=0; maxsize=8</td>
* <td>SmartDevice Link 1.0 </td>
* </tr>
* </table>
- * <b>Response</b><br><p>
- *<b>Non-default Result Codes:</b><br>
- * - SUCCESS<br>
- * - INVALID_DATA,<br>
- * - OUT_OF_MEMORY<br>
- * - CHAR_LIMIT_EXCEEDED<br>
- * - TOO_MANY_PENDING_REQUESTS<br>
- * - APPLICATION_NOT_REGISTERED<br>
- * - GENERIC_ERROR <br>
- * - DISALLOWED<br>
- * - UNSUPPORTED_RESOURCE <br>
- * - REJECTED <br>
- * - ABORTED<br>
+ * <p> <b>Response</b></p>
+ *<b>Non-default Result Codes:</b>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA </p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>CHAR_LIMIT_EXCEEDED</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>DISALLOWED</p>
+ * <p>UNSUPPORTED_RESOURCE</p>
+ * <p>REJECTED </p>
+ * <p>ABORTED</p>
*
* @see scrollableMessageBody
* @see TextFieldName
@@ -82,7 +82,7 @@ public class ScrollableMessage extends RPCRequest { /**
* Constructs a new ScrollableMessage object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -97,7 +97,7 @@ public class ScrollableMessage extends RPCRequest { * @param scrollableMessageBody
* a String value representing the Body of text that can include
* newlines and tabs
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setScrollableMessageBody(String scrollableMessageBody) {
@@ -123,7 +123,7 @@ public class ScrollableMessage extends RPCRequest { *
* @param timeout
* an Integer value representing an App defined timeout
- * <p>
+ * <p></p>
* <b>Notes</b>:Minval=0; Maxval=65535;Default=30000
*/
public void setTimeout(Integer timeout) {
@@ -150,7 +150,7 @@ public class ScrollableMessage extends RPCRequest { * @param softButtons
* a List<SoftButton> value representing App defined
* SoftButtons
- * <p>
+ * <p></p>
* <b>Notes: </b>Minsize=0, Maxsize=8
*/
public void setSoftButtons(List<SoftButton> softButtons) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java index 970782f35..880c27f95 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ScrollableMessageResponse.java @@ -22,7 +22,7 @@ public class ScrollableMessageResponse extends RPCResponse { /**
* Constructs a new ScrollableMessageResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java index 96e1a2c0d..cb5df057d 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -16,7 +16,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>majorVersion</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>
* <ul>
* <li>minvalue="1"</li>
@@ -27,7 +27,7 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>minorVersion</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>
* <ul>
* <li>minvalue="0"</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java index 0257a4c1c..dc77058de 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SendLocation.java @@ -46,8 +46,8 @@ public class SendLocation extends RPCRequest{ /** * Getter for longitude of the location to send. * - * <p><b>IMPORTANT NOTE:</b> A previous version of this method call returned a Float - * value, however, it has been changed to return a Double. This will compile, + * <p><b>IMPORTANT NOTE:</b> </p><p>A previous version of this method call returned a Float + * value, however, it has been changed to return a Double.</p> This will compile, * but cause a ClassCastException if your value is not also a Double type. * @since SmartDeviceLink v4.0 * @@ -74,8 +74,8 @@ public class SendLocation extends RPCRequest{ /** * Getter for latitude of the location to send. * - * <p><b>IMPORTANT NOTE:</b> A previous version of this method call returned a Float - * value, however, it has been changed to return a Double. This will compile, + * <p><b>IMPORTANT NOTE:</b> </p><p>A previous version of this method call returned a Float + * value, however, it has been changed to return a Double.</p> This will compile, * but cause a ClassCastException if your value is not also a Double type. * @since SmartDeviceLink v4.0 * diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java index 65e58e367..2cb5aef31 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIcon.java @@ -8,9 +8,9 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Used to set existing local file on SDL as the app's icon. Not supported on
* first generation SDL vehicles
- * <p>
- * <p><b>Parameter List</b>
- * <p>
+ *
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -30,18 +30,17 @@ import com.smartdevicelink.proxy.RPCRequest; * </tr>
*
* </table>
- * <p>
-*<b>Response </b>
-*<b> Non-default Result Codes: </b><br>
-*<p>
-* SUCCESS <br>
-* INVALID_DATA<br>
-* OUT_OF_MEMORY<br>
-* TOO_MANY_PENDING_REQUESTS<br>
-* APPLICATION_NOT_REGISTERED<br>
-* GENERIC_ERROR<br>
-* REJECTED<br>
-*
+ *
+ *<p><b>Response </b></p>
+ *<p><b> Non-default Result Codes: </b></p>
+ *<p>SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ *
* @since SmartDeviceLink 2.0
* @see Image
*/
@@ -57,7 +56,7 @@ public class SetAppIcon extends RPCRequest { /**
* Constructs a new SetAppIcon object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -71,7 +70,7 @@ public class SetAppIcon extends RPCRequest { *
* @param sdlFileName
* a String value representing a file reference name
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setSdlFileName(String sdlFileName) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java index 0ef29141a..c6d0f7ddf 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetAppIconResponse.java @@ -20,7 +20,7 @@ public class SetAppIconResponse extends RPCResponse { /**
* Constructs a new SetAppIconResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java index 593a3dd95..2a3fd9d4b 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java @@ -8,9 +8,9 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* Used to set an alternate display layout. If not sent, default screen for
* given platform will be shown
- * <p>
*
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -23,23 +23,23 @@ import com.smartdevicelink.proxy.RPCRequest; * <tr>
* <td>displayLayout</td>
* <td>string</td>
- * <td>Predefined or dynamically created screen layout.<br> Currently only predefined screen layouts are defined.<br> Predefined layouts include: "ONSCREEN_PRESETS"<br> Custom screen containing app-defined onscreen presets. <br></td>
+ * <td>Predefined or dynamically created screen layout.<p>Currently only predefined screen layouts are defined.</p> Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. </td>
* <td>Y</td>
* <td>maxlength: 500</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
* </table>
- *<b>Response </b>
- *<p>
- *<b> Non-default Result Codes: </b><br>
- * SUCCESS <br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
+ *<p><b>Response </b></p>
+ *
+ *<p><b> Non-default Result Codes: </b></p>
+ *<p> SUCCESS </p>
+ *<p> INVALID_DATA</p>
+ *<p> OUT_OF_MEMORY</p>
+ *<p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
* @since SmartDeviceLink 2.0
*/
public class SetDisplayLayout extends RPCRequest {
@@ -54,7 +54,7 @@ public class SetDisplayLayout extends RPCRequest { /**
* Constructs a new SetDisplayLayout object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java index 787bdd9f7..b9947a4ac 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java @@ -28,7 +28,7 @@ public class SetDisplayLayoutResponse extends RPCResponse { /**
* Constructs a new SetDisplayLayoutResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java index 5722f39dd..7f597cafe 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java @@ -9,19 +9,19 @@ import com.smartdevicelink.proxy.RPCRequest; import com.smartdevicelink.util.DebugTool;
/**
* Sets value(s) for the specified global property(ies)
- * <p>
- * Function Group: Base <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <b>AudioStreamingState:</b><br>
- * Any<br>
- * <p>
- * <b>SystemContext:</b><br>
- * Any<br>
- * <p>
*
- * <p><b>Parameter List</b>
- * <p>
+ * <p>Function Group: Base </p>
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>AudioStreamingState:</b></p>
+ * Any
+ *
+ * <p><b>SystemContext:</b></p>
+ * Any
+ *
+ *
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -36,7 +36,7 @@ import com.smartdevicelink.util.DebugTool; * <td>TTSChunk</td>
* <td>The help prompt. An array of text chunks of type TTSChunk. See {@linkplain TTSChunk}.The array must have at least one item.</td>
* <td>N</td>
- * <td>Array must have at least one element.<br>Only optional it timeoutPrompt has been specified.<br>minsize:1<br> maxsize: 100</td>
+ * <td>Array must have at least one element.<p>Only optional it timeoutPrompt has been specified.</p>minsize:1; maxsize: 100</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -44,7 +44,7 @@ import com.smartdevicelink.util.DebugTool; * <td>TTSChunk</td>
* <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>Array must have at least one element<br>Only optional it helpPrompt has been specified<br> minsize: 1<br> maxsize: 100</td>
+ * <td>Array must have at least one element. Only optional it helpPrompt has been specified <p>minsize: 1; maxsize: 100</p></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -52,7 +52,7 @@ import com.smartdevicelink.util.DebugTool; * <td>string</td>
* <td>Text, which is shown as title of the VR help screen used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the default SDL help title will be used. <br> If omitted and one or more vrHelp items are provided, the request will be rejected. <br>maxlength: 500</td>
+ * <td>If omitted on supported displays, the default SDL help title will be used. <p>If omitted and one or more vrHelp items are provided, the request will be rejected.</p>maxlength: 500</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -60,7 +60,7 @@ import com.smartdevicelink.util.DebugTool; * <td>VrHelep</td>
* <td>Items listed in the VR help screen used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used<br>If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC will be rejected.<br>If omitted and a vrHelpTitle is provided, the request will be rejected.<br>minsize:1<br> maxsize: 100 </td>
+ * <td>If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used<p>If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC will be rejected.</p><p>If omitted and a vrHelpTitle is provided, the request will be rejected.</p>minsize:1; maxsize: 100 </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -89,22 +89,20 @@ import com.smartdevicelink.util.DebugTool; * </tr>
*
* </table>
- * <p>
- * <b>Note: </b>Your application shall send a SetGlobalProperties to establish an advanced help prompt before sending any voice commands.
- * <p>
- * <b>Response</b><p>
-Indicates whether the requested Global Properties were successfully set. <br>
-<b>Non-default Result Codes:</b><P>
-
- - SUCCESS<br>
- - INVALID_DATA<br>
- - OUT_OF_MEMORY<br>
- - TOO_MANY_PENDING_REQUESTS<br>
- - APPLICATION_NOT_REGISTERED<br>
- - GENERIC_ERROR <br>
- - REJECTED <br>
- - DISALLOWED <br>
-
+ *
+ * <p><b>Note: </b>Your application shall send a SetGlobalProperties to establish an advanced help prompt before sending any voice commands.</p>
+ *
+ * <p><b>Response</b></p>
+ * Indicates whether the requested Global Properties were successfully set.
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * </p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
+ * <p>DISALLOWED</p>
* @since SmartDeviceLink 1.0
* @see ResetGlobalProperties
*/
@@ -125,7 +123,7 @@ public class SetGlobalProperties extends RPCRequest { /**
* Constructs a new SetGlobalProperties object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -167,7 +165,7 @@ public class SetGlobalProperties extends RPCRequest { *
* @param helpPrompt
* a List<TTSChunk> of one or more TTSChunk elements
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Array must have at least one element</li>
@@ -238,8 +236,8 @@ public class SetGlobalProperties extends RPCRequest { *
* @param vrHelpTitle
* a String value representing a voice recognition Help Title
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If omitted on supported displays, the default SDL help
* title will be used</li>
@@ -292,8 +290,8 @@ public class SetGlobalProperties extends RPCRequest { * @param vrHelp
* a List value representing items listed in the VR help screen
* used in an interaction started by PTT
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If omitted on supported displays, the default SmartDeviceLink VR
* help / What Can I Say? screen will be used</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java index bef494e69..f33bc0b7c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetGlobalPropertiesResponse.java @@ -22,7 +22,7 @@ public class SetGlobalPropertiesResponse extends RPCResponse { /**
* Constructs a new SetGlobalPropertiesResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java index d3b88b5c0..bd6bac324 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java @@ -8,12 +8,12 @@ import com.smartdevicelink.proxy.rpc.enums.UpdateMode; /**
* Sets the media clock/timer value and the update method (e.g.count-up,
* count-down, etc.)
- * <p>
- * Function Group: Base <p>
- * <b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b>
- * </p>
- * <p><b>Parameter List</b>
- * <p>
+ *
+ * <p>Function Group: Base </p>
+ * <p><b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -35,11 +35,11 @@ import com.smartdevicelink.proxy.rpc.enums.UpdateMode; * <td>endTime</td>
* <td>StartTime</td>
* <td> EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored)
- If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA.
- endTime will be ignored for "RESUME", and "CLEAR"
- endTime can be sent for "PAUSE", in which case it will update the paused endTime</td>
+ * If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA.
+ * endTime will be ignored for "RESUME", and "CLEAR"
+ * endTime can be sent for "PAUSE", in which case it will update the paused endTime</td>
* <td>N</td>
- * <td>Array must have at least one element<br>Only optional it helpPrompt has been specified<br> minsize: 1<br> maxsize: 100</td>
+ * <td>Array must have at least one element.<p>Only optional it helpPrompt has been specified</p> minsize: 1; maxsize: 100</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -47,25 +47,25 @@ import com.smartdevicelink.proxy.rpc.enums.UpdateMode; * <td>UpdateMode</td>
* <td>Specifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.</td>
* <td>Y</td>
- * <td>If "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. <br>Will be ignored for PAUSE,RESUME and CLEAR</td>
+ * <td>If "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEAR</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
*
* </table>
- * <p>
- *<b>Response </b>
- *<p>
- *<b> Non-default Result Codes: </b>
- *<p>
- * SUCCESS <br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * IGNORED <br>
+ *
+ *<p><b>Response </b></p>
+ *
+ *<p><b> Non-default Result Codes: </b></p>
+ *
+ * <p> SUCCESS </p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED </p>
+ * <p> IGNORED </p>
*
* @since SmartDeviceLink 1.0
*/
@@ -82,7 +82,7 @@ public class SetMediaClockTimer extends RPCRequest { /**
* Constructs a new SetMediaClockTimer object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -111,7 +111,7 @@ public class SetMediaClockTimer extends RPCRequest { *
* @param startTime
* a startTime object with specifying hour, minute, second values
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If "updateMode" is COUNTUP or COUNTDOWN, this parameter
@@ -165,7 +165,7 @@ public class SetMediaClockTimer extends RPCRequest { *
* @param updateMode
* a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>When updateMode is PAUSE, RESUME or CLEAR, the start time value
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java index 410b5b68c..e74ecc1b9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SetMediaClockTimerResponse.java @@ -22,7 +22,7 @@ public class SetMediaClockTimerResponse extends RPCResponse { /**
* Constructs a new SetMediaClockTimerResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java index 527b8b060..24307c9de 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Show.java @@ -14,20 +14,20 @@ import com.smartdevicelink.util.DebugTool; * this text area is visible to the user at the time of the request. The
* application's display text area remains unchanged until updated by subsequent
* calls to Show
- * <p>
+ * <p></p>
* The content of the application's display text area is visible to the user
* when the application's {@linkplain com.smartdevicelink.proxy.rpc.enums.HMILevel}
* is FULL or LIMITED, and the
* {@linkplain com.smartdevicelink.proxy.rpc.enums.SystemContext}=MAIN and no
* {@linkplain Alert} is in progress
- * <p>
+ * <p></p>
* The Show operation cannot be used to create an animated scrolling screen. To
* avoid distracting the driver, Show commands cannot be issued more than once
* every 4 seconds. Requests made more frequently than this will be rejected
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -42,7 +42,7 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Text to be displayed in a single-line display, or in the upper display line in a two-line display.</td>
* <td>N</td>
- * <td>If this parameter is omitted, the text of mainField1 does not change. <br>If this parameter is an empty string, the field will be cleared. <br>Maxlength = 500</td>
+ * <td>If this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared. <p>Maxlength = 500</p></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -50,7 +50,7 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Text to be displayed on the second display line of a two-line display.</td>
* <td>N</td>
- * <td>If this parameter is omitted, the text of mainField2 does not change. <br> If this parameter is an empty string, the field will be cleared.<br>If provided and the display is a single-line display, the parameter is ignored.<br>Maxlength = 500</td>
+ * <td><p>If this parameter is omitted, the text of mainField2 does not change. </p> <p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -58,7 +58,7 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Text to be displayed on the first display line of the second page.</td>
* <td>N</td>
- * <td>If this parameter is omitted, the text of mainField3 does not change. <br>f this parameter is an empty string, the field will be cleared.<br>If provided and the display is a single-line display, the parameter is ignored.<br> Maxlength = 500</td>
+ * <td><p>If this parameter is omitted, the text of mainField3 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p> Maxlength = 500</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -66,7 +66,7 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Text to be displayed on the second display line of the second page.</td>
* <td>N</td>
- * <td>If this parameter is omitted, the text of mainField4 does not change. <br>If this parameter is an empty string, the field will be cleared.<br>If provided and the display is a single-line display, the parameter is ignored.<br>Maxlength = 500</td>
+ * <td><p>If this parameter is omitted, the text of mainField4 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -74,7 +74,7 @@ import com.smartdevicelink.util.DebugTool; * <td>TextAlignment</td>
* <td>Specifies how mainField1 and mainField2 text should be aligned on display.</td>
* <td>N</td>
- * <td>Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.<br>If this parameter is omitted, text in both mainField1 and mainField2 will be centered. <br>Has no effect with navigation display</td>
+ * <td><p>Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.</p><p>If this parameter is omitted, text in both mainField1 and mainField2 will be centered. </p>Has no effect with navigation display</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -82,15 +82,15 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>The text is placed in the status bar area.</td>
* <td>N</td>
- * <td>Note: The status bar only exists on navigation displays<br>If this parameter is omitted, the status bar text will remain unchanged.<br>If this parameter is an empty string, the field will be cleared.<br>If provided and the display has no status bar, this parameter is ignored.<br>Maxlength = 500</td>
+ * <td><p>Note: The status bar only exists on navigation displays</p><p>If this parameter is omitted, the status bar text will remain unchanged.</p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display has no status bar, this parameter is ignored.</p>Maxlength = 500</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>mediaClock</td>
* <td>String</td>
- * <td>Text value for MediaClock field.<br> Has to be properly formatted by Mobile App according to SDL capabilities.<br>If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.</td>
+ * <td><p>Text value for MediaClock field.</p> <p>Has to be properly formatted by Mobile App according to SDL capabilities.</p>If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.</td>
* <td>N</td>
- * <td>Must be properly formatted as described in the MediaClockFormat enumeration. <br>If a value of five spaces is provided, this will clear that field on the display (i.e. the media clock timer field will not display anything) <br>Maxlength = 500</td>
+ * <td><p>Must be properly formatted as described in the MediaClockFormat enumeration. </p><p>If a value of five spaces is provided, this will clear that field on the display (i.e. the media clock timer field will not display anything) </p>Maxlength = 500</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -98,7 +98,7 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>If parameter is omitted, the track field remains unchanged.<br>If an empty string is provided, the field will be cleared.<br>This field is only valid for media applications on navigation displays.<br>Maxlength = 500</td>
+ * <td><p>If parameter is omitted, the track field remains unchanged.</p><p>If an empty string is provided, the field will be cleared.</p><p>This field is only valid for media applications on navigation displays.</p>Maxlength = 500</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
@@ -112,7 +112,7 @@ import com.smartdevicelink.util.DebugTool; * <tr>
* <td>secondaryGraphic</td>
* <td>Image</td>
- * <td> Image struct determining whether static or dynamic secondary image to display in app.<br>If omitted on supported displays, the displayed secondary graphic shall not change.</td>
+ * <td> <p>Image struct determining whether static or dynamic secondary image to display in app.</p>If omitted on supported displays, the displayed secondary graphic shall not change.</td>
* <td>N</td>
* <td> </td>
* <td>SmartDeviceLink 2.3.2</td>
@@ -122,7 +122,7 @@ import com.smartdevicelink.util.DebugTool; * <td>SoftButton</td>
* <td>Soft buttons as defined by the App</td>
* <td>N</td>
- * <td>If omitted on supported displays, the currently displayed SoftButton values will not change.<br>Array Minsize: 0<br>Array Maxsize: 8</td>
+ * <td><p>If omitted on supported displays, the currently displayed SoftButton values will not change.</p>Array Minsize: 0; Array Maxsize: 8</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -130,24 +130,24 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Custom presets as defined by the App.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the presets will be shown as not defined.<br>Minsize: 0<br> Maxsize: 6</td>
+ * <td><p>If omitted on supported displays, the presets will be shown as not defined.</p>Minsize: 0; Maxsize: 6</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
* </table>
- *<b>Response </b><br>
- *<p>
- *<b> Non-default Result Codes: </b><br>
- * SUCCESS <br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY<br>
- * TOO_MANY_PENDING_REQUESTS<br>
- * APPLICATION_NOT_REGISTERED<br>
- * GENERIC_ERROR<br>
- * REJECTED<br>
- * DISALLOWED<br>
- * UNSUPPORTED_RESOURCE <br>
- * ABORTED<br>
+ *<p><b>Response </b></p>
+ *
+ *<p><b> Non-default Result Codes: </b></p>
+ * <p>SUCCESS </p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
+ * <p> DISALLOWED</p>
+ * <p> UNSUPPORTED_RESOURCE </p>
+ * <p>ABORTED</p>
*
* @since SmartDeviceLink 1.0
* @see Alert
@@ -174,7 +174,7 @@ public class Show extends RPCRequest { }
/**
* Constructs a new Show object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -201,7 +201,7 @@ public class Show extends RPCRequest { * the String value representing the text displayed in a
* single-line display, or in the upper display line in a
* two-line display
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField1 does
@@ -232,7 +232,7 @@ public class Show extends RPCRequest { * @param mainField2
* the String value representing the text displayed on the second
* display line of a two-line display
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField2 does
@@ -269,7 +269,7 @@ public class Show extends RPCRequest { * @param mainField3
* the String value representing the text displayed on the first
* display line of the second page
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField3 does
@@ -307,7 +307,7 @@ public class Show extends RPCRequest { * @param mainField4
* the String value representing the text displayed on the second
* display line of the second page
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>If this parameter is omitted, the text of mainField4 does
@@ -348,7 +348,7 @@ public class Show extends RPCRequest { *
* @param alignment
* an Enumeration value
- * <p>
+ * <p></p>
* <b>Notes: </b>
* <ul>
* <li>Applies only to mainField1 and mainField2 provided on this
@@ -379,9 +379,9 @@ public class Show extends RPCRequest { * @param statusBar
* a String representing the text you want to add in the Status
* Bar
- * <p>
+ * <p></p>
* <b>Notes: </b><i>The status bar only exists on navigation
- * displays</i><br/>
+ * displays</i>
* <ul>
* <li>If this parameter is omitted, the status bar text will
* remain unchanged</li>
@@ -413,8 +413,8 @@ public class Show extends RPCRequest { *
* @param mediaClock
* a String value for the MdaiaClock
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>Must be properly formatted as described in the
* MediaClockFormat enumeration</li>
@@ -444,8 +444,8 @@ public class Show extends RPCRequest { *
* @param mediaTrack
* a String value disaplayed in the track field
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If parameter is omitted, the track field remains unchanged</li>
* <li>If an empty string is provided, the field will be cleared</li>
@@ -465,9 +465,9 @@ public class Show extends RPCRequest { *
* @param graphic
* the value representing the image shown on supported displays
- * <p>
+ * <p></p>
* <b>Notes: </b>If omitted on supported displays, the displayed
- * graphic shall not change<br/>
+ * graphic shall not change
* @since SmartDeviceLink 2.0
*/
public void setGraphic(Image graphic) {
@@ -559,8 +559,8 @@ public class Show extends RPCRequest { * @param softButtons
* a List value represemting the Soft buttons defined by the
* App
- * <p>
- * <b>Notes: </b><br/>
+ * <p></p>
+ * <b>Notes: </b>
* <ul>
* <li>If omitted on supported displays, the currently displayed
* SoftButton values will not change</li>
@@ -605,7 +605,7 @@ public class Show extends RPCRequest { * @param customPresets
* a List value representing the Custom Presets defined by the
* App
- * <p>
+ * <p></p>
* <ul>
* <li>If omitted on supported displays, the presets will be shown as not defined</li>
* <li>Array Minsize: 0</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java index 293adddbe..f65e1a100 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java @@ -8,13 +8,13 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest; /** - * This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but - * also for the alert type screen - * <p> - * Function Group: Navigation - * <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * <p> + * <p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but + * also for the alert type screen</p> + * + * <p>Function Group: Navigation</p> + * + * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> + * * * @since SmartDeviceLink 2.0 * @see AlertManeuver @@ -57,7 +57,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param navigationText1 * a String value representing a text for navigation text field 1 - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setNavigationText1(String navigationText1){ @@ -83,7 +83,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param navigationText2 * a String value representing a text for navigation text field 2 - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setNavigationText2(String navigationText2){ @@ -109,7 +109,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param eta * a String value representing a text field for estimated time of arrival - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setEta(String eta){ @@ -135,7 +135,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param totalDistance * a String value representing a text field for total distance - * <p> + * <p></p> * <b>Notes: </b>Maxlength=500 */ public void setTotalDistance(String totalDistance){ @@ -223,7 +223,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param distanceToManeuver * a Double value representing a Fraction of distance till next maneuver - * <p> + * <p></p> * <b>Notes: </b>Minvalue=0; Maxvalue=1000000000 */ public void setDistanceToManeuver(Double distanceToManeuver){ @@ -249,7 +249,7 @@ public class ShowConstantTbt extends RPCRequest{ * * @param distanceToManeuverScale * a Double value representing a Distance till next maneuver (starting from) from previous maneuver - * <p> + * <p></p> * <b>Notes: </b>Minvalue=0; Maxvalue=1000000000 */ public void setDistanceToManeuverScale(Double distanceToManeuverScale){ @@ -271,10 +271,10 @@ public class ShowConstantTbt extends RPCRequest{ } /** - * Sets a maneuver complete flag. If and when a maneuver has completed while an AlertManeuver is active, the app - * must send this value set to TRUE in order to clear the AlertManeuver overlay<br/> - * If omitted the value will be assumed as FALSE - * <p> + * <p>Sets a maneuver complete flag. If and when a maneuver has completed while an AlertManeuver is active, the app + * must send this value set to TRUE in order to clear the AlertManeuver overlay + * If omitted the value will be assumed as FALSE</p> + * * * @param maneuverComplete * a Boolean value @@ -298,10 +298,10 @@ public class ShowConstantTbt extends RPCRequest{ } /** - * Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported - * displays, the currently displayed SoftButton values will not change - * <p> - * <b>Notes: </b>Minsize=0; Maxsize=3 + * <p>Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported + * displays, the currently displayed SoftButton values will not change</p> + * + * <p><b>Notes: </b>Minsize=0; Maxsize=3</p> * * @param softButtons * a List<SoftButton> value diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java index e12c09029..54ff95033 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/ShowResponse.java @@ -22,7 +22,7 @@ public class ShowResponse extends RPCResponse { /**
* Constructs a new ShowResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java index 05e637321..ab30ff365 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SingleTireStatus.java @@ -7,7 +7,7 @@ import com.smartdevicelink.proxy.rpc.enums.ComponentVolumeStatus; /**
* Tire pressure status of a single tire.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java index 96a17624d..16da80dcb 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Slider.java @@ -7,14 +7,14 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
/**
- * Creates a full screen or pop-up overlay (depending on platform) with a single
- * user controlled slider.
- * <p>
- * Function Group: Base
- * <p>
- * <b>HMILevel needs to be FULL</b>
- * <p>
- * <p><b>Parameter List</b>
+ * <p>Creates a full screen or pop-up overlay (depending on platform) with a single
+ * user controlled slider.</p>
+ *
+ * <p>Function Group: Base</p>
+ *
+ * <p><b>HMILevel needs to be FULL</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -29,7 +29,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Number of selectable items on a horizontal axis.</td>
* <td>Y</td>
- * <td>Minvalue=2 <br>Maxvalue=26</td>
+ * <td>Minvalue=2; Maxvalue=26</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
@@ -38,7 +38,7 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>Integer</td>
* <td>Initial position of slider control (cannot exceed numTicks),</td>
* <td>Y</td>
- * <td>Minvalue=1<br>Maxvalue=26</td>
+ * <td>Minvalue=1; Maxvalue=26</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -52,9 +52,9 @@ import com.smartdevicelink.proxy.RPCRequest; * <tr>
* <td>sliderFooter</td>
* <td>Integer</td>
- * <td>Text footer to display (meant to display min/max threshold descriptors).<br> For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.</td>
+ * <td><p>Text footer to display (meant to display min/max threshold descriptors).</p>For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.</td>
* <td>N</td>
- * <td>Maxlength=500<br>Minvalue=1<br> Maxvalue=26</td>
+ * <td>Maxlength=500; Minvalue=1; Maxvalue=26</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
@@ -63,23 +63,23 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>String</td>
* <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.</td>
* <td>N</td>
- * <td>Minvalue=0<br>Maxvalue=65535<br>Defvalue= 10000</td>
+ * <td>Minvalue=0; Maxvalue=65535; Defvalue= 10000</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
-*<b>Response </b><br>
-*<p>
-*<b>Non-default Result Codes:</b> <br>
-* SAVED <br>
-* INVALID_DATA <br>
-* OUT_OF_MEMORY <br>
-* TOO_MANY_PENDING_REQUESTS <br>
-* APPLICATION_NOT_REGISTERED <br>
-* GENERIC_ERROR <br>
-* DISALLOWED <br>
-* UNSUPPORTED_RESOURCE <br>
-* REJECTED <br>
-* ABORTED <br>
+*<p><b>Response </b></p>
+*
+*<p><b>Non-default Result Codes:</b></p>
+* <p> SAVED </p>
+* <p> INVALID_DATA</p>
+* <p>OUT_OF_MEMORY</p>
+* <p>TOO_MANY_PENDING_REQUESTS</p>
+* <p>APPLICATION_NOT_REGISTERED</p>
+* <p>GENERIC_ERROR</p>
+*<p> DISALLOWED</p>
+*<p> UNSUPPORTED_RESOURCE </p>
+*<p> REJECTED </p>
+* <p>ABORTED </p>
*
* @since SmartDeviceLink 2.0
*
@@ -100,7 +100,7 @@ public class Slider extends RPCRequest { /**
* Constructs a new Slider object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -115,7 +115,7 @@ public class Slider extends RPCRequest { * @param numTicks
* an Integer value representing a number of selectable items on
* a horizontal axis
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue=2; Maxvalue=26
*/
public void setNumTicks(Integer numTicks) {
@@ -142,7 +142,7 @@ public class Slider extends RPCRequest { * @param position
* an Integer value representing an Initial position of slider
* control
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue=1; Maxvalue=26
*/
public void setPosition(Integer position) {
@@ -168,7 +168,7 @@ public class Slider extends RPCRequest { *
* @param sliderHeader
* a String value
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500
*/
public void setSliderHeader(String sliderHeader) {
@@ -193,7 +193,7 @@ public class Slider extends RPCRequest { *
* @param sliderFooter
* a List<String> value representing a text footer to display
- * <p>
+ * <p></p>
* <b>Notes: </b>Maxlength=500; Minvalue=1; Maxvalue=26
*/
public void setSliderFooter(List<String> sliderFooter) {
@@ -228,7 +228,7 @@ public class Slider extends RPCRequest { *
* @param timeout
* an Integer value representing an App defined timeout
- * <p>
+ * <p></p>
* <b>Notes: </b>Minvalue=0; Maxvalue=65535; Defvalue=10000
*/
public void setTimeout(Integer timeout) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java index 6d168b6ea..0d8487d12 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SliderResponse.java @@ -23,7 +23,7 @@ public class SliderResponse extends RPCResponse { /**
* Constructs a new SliderResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java index 763ac5c88..e010a08da 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButton.java @@ -7,9 +7,9 @@ import com.smartdevicelink.proxy.rpc.enums.SoftButtonType; import com.smartdevicelink.proxy.rpc.enums.SystemAction;
import com.smartdevicelink.util.DebugTool;
/**
- * A simulated button or keyboard key that is displayed on a touch screen.
- *<p>
- * <p><b>Parameter List</b>
+ * <p> A simulated button or keyboard key that is displayed on a touch screen.</p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -32,7 +32,7 @@ import com.smartdevicelink.util.DebugTool; * <td>String</td>
* <td>Optional text to display (if defined as TEXT or BOTH)</td>
* <td>N</td>
- * <td>Min: 0 <br>Maxlength: 500</td>
+ * <td>Min: 0; Maxlength: 500</td>
* <td>SmartDeviceLink 2.0 </td>
* </tr>
* <tr>
@@ -46,7 +46,7 @@ import com.smartdevicelink.util.DebugTool; * <tr>
* <td>isHighlighted</td>
* <td>Boolean</td>
- * <td>True, if highlighted <br>False, if not highlighted</td>
+ * <td>True, if highlighted False, if not highlighted</td>
* <td>N</td>
* <td></td>
* <td>SmartDeviceLink 2.0</td>
@@ -56,7 +56,7 @@ import com.smartdevicelink.util.DebugTool; * <td>Integer</td>
* <td>Value which is returned via OnButtonPress / OnButtonEvent</td>
* <td></td>
- * <td>Min: 0 <br> Max: 65535</td>
+ * <td>Min: 0; Max: 65535</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
@@ -80,10 +80,10 @@ public class SoftButton extends RPCStruct { public static final String KEY_TYPE = "type";
public static final String KEY_IMAGE = "image";
/**
- * <p>
- * Constructs a new SoftButton object indicated by the Hashtable
- * parameter
- * </p>
+ *
+ * <p>Constructs a new SoftButton object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java index 5f6de1a96..e2849086c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java @@ -5,8 +5,8 @@ import java.util.Hashtable; import com.smartdevicelink.proxy.RPCStruct;
/**
- * Contains information about a SoftButton's capabilities.
- * <p><b>Parameter List</b>
+ * <p>Contains information about a SoftButton's capabilities.</p>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java index 015f70adf..b5e775f06 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Speak.java @@ -12,50 +12,50 @@ import com.smartdevicelink.proxy.RPCRequest; * (text-to-speech) engine. The provided text to be spoken can be simply a text
* phrase, or it can consist of phoneme specifications to direct SDL's TTS
* engine to speak a "speech-sculpted" phrase
- * <p>
+ * <p></p>
* Receipt of the Response indicates the completion of the Speak operation,
* regardless of how the Speak operation may have completed (i.e. successfully,
* interrupted, terminated, etc.)
- * <p>
+ * <p></p>
* Requesting a new Speak operation while the application has another Speak
* operation already in progress (i.e. no corresponding Response for that
* in-progress Speak operation has been received yet) will terminate the
* in-progress Speak operation (causing its corresponding Response to be sent by
* SDL) and begin the requested Speak operation
- * <p>
+ * <p></p>
* Requesting a new Speak operation while the application has an <i>
* {@linkplain Alert}</i> operation already in progress (i.e. no corresponding
* Response for that in-progress <i>{@linkplain Alert}</i> operation has been
* received yet) will result in the Speak operation request being rejected
* (indicated in the Response to the Request)
- * <p>
+ * <p></p>
* Requesting a new <i>{@linkplain Alert}</i> operation while the application
* has a Speak operation already in progress (i.e. no corresponding Response for
* that in-progress Speak operation has been received yet) will terminate the
* in-progress Speak operation (causing its corresponding Response to be sent by
* SDL) and begin the requested <i>{@linkplain Alert}</i> operation
- * <p>
+ * <p></p>
* Requesting a new Speak operation while the application has a <i>
* {@linkplain PerformInteraction}</i> operation already in progress (i.e. no
* corresponding Response for that in-progress <i>
* {@linkplain PerformInteraction}</i> operation has been received yet) will
* result in the Speak operation request being rejected (indicated in the
* Response to the Request)
- * <p>
+ * <p></p>
* Requesting a <i> {@linkplain PerformInteraction}</i> operation while the
* application has a Speak operation already in progress (i.e. no corresponding
* Response for that in-progress Speak operation has been received yet) will
* terminate the in-progress Speak operation (causing its corresponding Response
* to be sent by SDL) and begin the requested <i>
* {@linkplain PerformInteraction}</i> operation
- * <p>
+ * <p></p>
*
- * <b>HMI Status Requirements:</b><br/>
- * HMILevel: FULL, Limited<br/>
- * AudioStreamingState: Any<br/>
- * SystemContext: MAIN, MENU, VR
- * </p>
- * <b>Notes: </b>
+ * <p><b>HMI Status Requirements:</b></p>
+ * <p>HMILevel: FULL, Limited</p>
+ *<p> AudioStreamingState: Any</p>
+ * <p>SystemContext: MAIN, MENU, VR</p>
+ *
+ * <p><b>Notes: </b></p>
* <ul>
* <li>When <i>{@linkplain Alert}</i> is issued with MENU in effect, <i>
* {@linkplain Alert}</i> is queued and "played" when MENU interaction is
@@ -67,9 +67,9 @@ import com.smartdevicelink.proxy.RPCRequest; * VR, they are "played" back in the order in which they were queued, with all
* existing rules for "collisions" still in effect</li>
* </ul>
- * <p>
*
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -84,27 +84,27 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>String</td>
* <td>An array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.</td>
* <td>Y</td>
- * <td>The array must have 1-100 elements. <br>The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected. <br>Each chunk can be no more than 500 characters.</td>
+ * <td><p>The array must have 1-100 elements. </p><p>The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected. </p>Each chunk can be no more than 500 characters.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- * <b>Response</b> <br>
- * This Response notifies the application of the completion, interruption, or failure of a Speak Request. <br>
- * <p>
- * <b>Non-default Result Codes:</b> <br>
- * <p>
- * SUCCESS <br>
- * INVALID_DATA<br>
- * OUT_OF_MEMORY <br>
- * APPLICATION_NOT_REGISTERED <br>
- * TOO_MANY_PENDING_REQUESTS <br>
- * GENERIC_ERROR <br>
- * REJECTED <br>
- * DISALLOWED <br>
- * ABORTED <br>
- * <p>
- * <b>Additional Notes:</b><br><ul>Total character limit depends on platform. Chunks are limited to 500 characters; however you can have multiple TTS chunks. On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.
- * <p>
+ * <p><b>Response</b> </p>
+ * <p>This Response notifies the application of the completion, interruption, or failure of a Speak Request.</p>
+ *
+ * <p><b>Non-default Result Codes:</b> </p>
+ *
+ * <p> SUCCESS </p>
+ *<p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY </p>
+ * <p>APPLICATION_NOT_REGISTERED </p>
+ * <p>TOO_MANY_PENDING_REQUESTS </p>
+ *<p> GENERIC_ERROR </p>
+ * <p>REJECTED </p>
+ * <p>DISALLOWED </p>
+ * <p>ABORTED </p>
+ *
+ * <p><b>Additional Notes:</b></p><ul>Total character limit depends on platform. Chunks are limited to 500 characters; however you can have multiple TTS chunks. On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.
+ *
* @since SmartDeviceLink 1.0
* @see Alert
*/
@@ -119,7 +119,7 @@ public class Speak extends RPCRequest { }
/**
* Constructs a new Speak object indicated by the Hashtable parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
@@ -159,7 +159,7 @@ public class Speak extends RPCRequest { * @param ttsChunks
* a List<TTSChunk> value representing an array of 1-100 TTSChunk structs
* which specify the phrase to be spoken
- * <p>
+ * <p></p>
* <ul>
* <li>The array must have 1-100 elements</li>
* <li>The total length of the phrase composed from the ttsChunks
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java index 3e7be103c..740d24776 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SpeakResponse.java @@ -22,7 +22,7 @@ public class SpeakResponse extends RPCResponse { /**
* Constructs a new SpeakResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java index 87ab9b755..bce0b9fc1 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/StartTime.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Describes the hour, minute and second values used to set the media clock.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -16,21 +16,21 @@ import com.smartdevicelink.proxy.RPCStruct; * </tr>
* <tr>
* <td>hours</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>minutes</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The minute. Minvalue="0", maxvalue="59".</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>seconds</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The second. Minvalue="0", maxvalue="59".</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
@@ -55,7 +55,7 @@ public class StartTime extends RPCStruct { }
/**
* Get the hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* @return hours Minvalue="0", maxvalue="59"
*/
public Integer getHours() {
@@ -63,7 +63,7 @@ public class StartTime extends RPCStruct { }
/**
* Set the hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* @param hours min: 0; max: 59
*/
public void setHours( Integer hours ) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java index ed273497d..7f1f92bae 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButton.java @@ -6,52 +6,52 @@ import com.smartdevicelink.protocol.enums.FunctionID; import com.smartdevicelink.proxy.RPCRequest;
import com.smartdevicelink.proxy.rpc.enums.ButtonName;
/**
- * Establishes a subscription to button notifications for HMI buttons. Buttons
+ *<p> Establishes a subscription to button notifications for HMI buttons. Buttons
* are not necessarily physical buttons, but can also be "soft" buttons on a
* touch screen, depending on the display in the vehicle. Once subscribed to a
* particular button, an application will receive both
* {@linkplain OnButtonEvent} and {@linkplain OnButtonPress} notifications
* whenever that button is pressed. The application may also unsubscribe from
* notifications for a button by invoking the {@linkplain UnsubscribeButton}
- * operation
- * <p>
- * When a button is depressed, an {@linkplain OnButtonEvent} notification is
+ * operation</p>
+ *
+ * <p>When a button is depressed, an {@linkplain OnButtonEvent} notification is
* sent to the application with a ButtonEventMode of BUTTONDOWN. When that same
* button is released, an {@linkplain OnButtonEvent} notification is sent to the
- * application with a ButtonEventMode of BUTTONUP
- * <p>
- * When the duration of a button depression (that is, time between depression
+ * application with a ButtonEventMode of BUTTONUP</p>
+ *
+ * <p>When the duration of a button depression (that is, time between depression
* and release) is less than two seconds, an {@linkplain OnButtonPress}
* notification is sent to the application (at the moment the button is
* released) with a ButtonPressMode of SHORT. When the duration is two or more
* seconds, an {@linkplain OnButtonPress} notification is sent to the
* application (at the moment the two seconds have elapsed) with a
- * ButtonPressMode of LONG
- * <p>
+ * ButtonPressMode of LONG</p>
+ *
* The purpose of {@linkplain OnButtonPress} notifications is to allow for
* programmatic detection of long button presses similar to those used to store
* presets while listening to the radio, for example
- * <p>
- * When a button is depressed and released, the sequence in which notifications
- * will be sent to the application is as follows:
- * <p>
- * For short presses:<br/>
+ *
+ * <p>When a button is depressed and released, the sequence in which notifications
+ * will be sent to the application is as follows:</p>
+ *
+ * <p>For short presses:</p>
* <ul>
* <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li>
* <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li>
* <li>OnButtonPress (ButtonPressMode = SHORT)</li>
* </ul>
- * <p>
- * For long presses:<br/>
+ *
+ * <p>For long presses:</p>
* <ul>
* <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li>
* <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li>
* <li>OnButtonPress (ButtonPressMode = LONG)</li>
* </ul>
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <p><b>Parameter List</b>
+ *
+ *<p> <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -83,9 +83,9 @@ public class SubscribeButton extends RPCRequest { super(FunctionID.SUBSCRIBE_BUTTON.toString());
}
/**
- * Constructs a new SubscribeButton object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeButton object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java index b51f75eee..81fca78c2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeButtonResponse.java @@ -20,9 +20,9 @@ public class SubscribeButtonResponse extends RPCResponse { }
/**
- * Constructs a new SubscribeButtonResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeButtonResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java index e5fe4a2cb..6b934ef21 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java @@ -11,12 +11,12 @@ import com.smartdevicelink.proxy.RPCRequest; * onVehicleData notification whenever new data is available. The update rate is
* very much dependent on sensors, vehicle architecture and vehicle type. Be
* also prepared for the situation that a signal is not available on a vehicle
- * <p>
- * Function Group: Location, VehicleInfo and DrivingChara
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <p><b>Parameter List</b>
+ *
+ * <p>Function Group: Location, VehicleInfo and DrivingChara</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -219,19 +219,19 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SmartDeviceLink 2.0 </td>
* </tr>
* </table>
- * <p>
- * <b>Response</b><p>
- *<b>Non-default Result Codes:</b><br>
- * - SUCCESS<br>
- * - WARNINGS <br>
- * - INVALID_DATA<br>
- * - OUT_OF_MEMORY<br>
- * - TOO_MANY_PENDING_REQUESTS<br>
- * - APPLICATION_NOT_REGISTERED<br>
- * - GENERIC_ERROR <br>
- * - IGNORED <br>
- * - DISALLOWED<br>
- * - USER_DISALLOWED <br>
+ *
+ * <p> <b>Response</b></p>
+ *<p><b>Non-default Result Codes:</b></p>
+ *<p>SUCCESS</p>
+ *<p>WARNINGS </p>
+ *<p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED </p>
+ * <p>DISALLOWED</p>
+ * <p>USER_DISALLOWED </p>
*
* @since SmartDeviceLink 2.0
* @see UnsubscribeVehicleData
@@ -271,9 +271,9 @@ public class SubscribeVehicleData extends RPCRequest { }
/**
- * Constructs a new SubscribeVehicleData object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeVehicleData object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java index 327e0f7d6..f8092cae8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java @@ -45,9 +45,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { }
/**
- * Constructs a new SubscribeVehicleDataResponse object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new SubscribeVehicleDataResponse object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java index f5d8edb12..14164b964 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/SystemRequest.java @@ -6,9 +6,9 @@ import java.util.List; import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import com.smartdevicelink.proxy.rpc.enums.RequestType;
-/** An asynchronous request from the device; binary data can be included in hybrid part of message for some requests<br> (such as HTTP, Proprietary, or Authentication requests)
- * <p>
- * <p><b>Parameter List</b>
+/** An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -30,14 +30,14 @@ import com.smartdevicelink.proxy.rpc.enums.RequestType; * <tr>
* <td>fileName</td>
* <td>String</td>
- * <td>Filename of HTTP data to store in predefined system staging area.<br>Mandatory if requestType is HTTP.<br>PROPRIETARY requestType should ignore this parameter. </td>
+ * <td>Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. </td>
* <td>N</td>
- * <td>Max Length: 255<br></td>
+ * <td>Max Length: 255</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* </table>
* @since SmartDeviceLink 3.0
- * <p>
+ *
*
*
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java index 2baf9f955..97f865903 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TTSChunk.java @@ -6,15 +6,15 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities;
/**
- * Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules.
+ * <p>Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules.
* It can also be phonemes from either the Microsoft SAPI phoneme set, or from the LHPLUS phoneme set.
- * It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).
+ * It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).</p>
*
* <p>In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronounciation to the TTS engine.
* For example, to have SDL pronounce the word "read" as "red", rather than as when it is pronounced like "reed",
- * the developer would use phonemes to express this desired pronounciation.
- * <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a>.
- * <p><b> Parameter List</b>
+ * the developer would use phonemes to express this desired pronounciation.</p>
+ * <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a></p>.
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java index e1da69665..918f0eb2f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TextField.java @@ -8,7 +8,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; /**
* Struct defining the characteristics of a displayed field on the HMI.
- * <p><b> Parameter List</b>
+ * <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -30,7 +30,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; * </tr>
* <tr>
* <td>width</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The number of characters in one row of this field.
* <ul>
* <li>Minvalue="1"</li>
@@ -41,7 +41,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; * </tr>
* <tr>
* <td>rows</td>
- * <td>Int16</td>
+ * <td>Integer</td>
* <td>The number of rows for this text field.
* <ul>
* <li>Minvalue="1"</li>
@@ -52,7 +52,7 @@ import com.smartdevicelink.proxy.rpc.enums.TextFieldName; * </tr>
* </table>
* @since SmartDeviceLink 1.0
- * <p>
+ *
* @see TextFieldName
* @see Alert
* @see Show
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java index 3bd4b844e..f853d673c 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TireStatus.java @@ -6,14 +6,14 @@ import com.smartdevicelink.proxy.RPCStruct; import com.smartdevicelink.proxy.rpc.enums.WarningLightStatus;
import com.smartdevicelink.util.DebugTool;
/** <p>The status and pressure of the tires.</p>
- * <p><b> Parameter List:</b>
- * <p>
+ * <p><b> Parameter List:</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
* <th>Type</th>
* <th>Description</th>
- * <th>Version</>
+ * <th>Version</th>
* </tr>
* <tr>
* <td>PressureTellTale</td>
@@ -58,9 +58,9 @@ import com.smartdevicelink.util.DebugTool; * <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
- * <p>
+ *
* @since SmartDeviceLink 2.0
- * <p>
+ *
* @see WarningLightStatus
* @see SingleTireStatus
* @see GetVehicleData
@@ -76,12 +76,12 @@ public class TireStatus extends RPCStruct { public static final String KEY_INNER_RIGHT_REAR = "innerRightRear";
public static final String KEY_RIGHT_REAR = "rightRear";
/**
- * Constructs a new TireStatus object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new TireStatus object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* <p>
- * The Hashtable to use
+ * The Hashtable to use</p>
*/
public TireStatus() { }
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java index 697e76652..95f793fe6 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchCoord.java @@ -5,10 +5,10 @@ import com.smartdevicelink.proxy.RPCStruct; import java.util.Hashtable;
/**
* <p>The x or y coordinate of the touch.</p>
- * <p>
*
*
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -23,7 +23,7 @@ import java.util.Hashtable; * <td>Integer</td>
* <td>The x coordinate of the touch.</td>
* <td>Y</td>
- * <td>minvalue = 0 <br>maxvalue = 10000</td>
+ * <td>minvalue = 0; maxvalue = 10000</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* <tr>
@@ -31,7 +31,7 @@ import java.util.Hashtable; * <td>Integer</td>
* <td>The y coordinate of the touch.</td>
* <td>Y</td>
- * <td>minvalue = 0 <br>maxvalue = 10000</td>
+ * <td>minvalue = 0; maxvalue = 10000</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* </table>
@@ -47,12 +47,12 @@ public class TouchCoord extends RPCStruct { public static final String KEY_Y = "y";
public TouchCoord() {}
/**
- * Constructs a new TouchCoord object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new TouchCoord object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* <p>
- * The Hashtable to use
+ * The Hashtable to use</p>
*/
public TouchCoord(Hashtable<String, Object> hash) {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java index 9b610d58c..8d13baa21 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEvent.java @@ -6,10 +6,10 @@ import java.util.List; import com.smartdevicelink.proxy.RPCStruct;
/**
- * For touchscreen interactions, the mode of how the choices are presented.<br>
+ * <p>For touchscreen interactions, the mode of how the choices are presented.</p>
*
- * <p><b>Parameter List</b>
- * <p>
+ * <p><b>Parameter List</b></p>
+ *
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -24,15 +24,15 @@ import com.smartdevicelink.proxy.RPCStruct; * <td>Integer</td>
* <td> A touch's unique identifier. The application can track the current touch events by id. If a touch event has type begin, the id should be added to the set of touches. If a touch event has type end, the id should be removed from the set of touches.</td>
* <td>N</td>
- * <td>Min Value: 0 <br>Max Value: 9</td>
+ * <td>Min Value: 0; Max Value: 9</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* <tr>
* <td>ts</td>
* <td>Float</td>
- * <td>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.<br>
- * The timestamp is used to determined the rate of change of position of a touch.<br>The application also uses the time to verify whether two touches,<br> with different ids, are part of a single action by the user.<br>
- * If there is only a single timestamp in this array,<br> it is the same for every coordinate in the coordinates array.</td>
+ * <td>The time that the touch was recorded. <p> This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p>
+ * <p>The timestamp is used to determined the rate of change of position of a touch.</p><p>The application also uses the time to verify whether two touches,with different ids, are part of a single action by the user.</p>
+ * <p>If there is only a single timestamp in this array,</p> it is the same for every coordinate in the coordinates array.</td>
* <td>Y</td>
* <td>minvalue="0" maxvalue="5000000000" minsize="1" maxsize="1000"</td>
* <td>SmartDeviceLink 3.0 </td>
@@ -46,9 +46,9 @@ import com.smartdevicelink.proxy.RPCStruct; * <td>SmartDeviceLink 3.0</td>
* </tr>
* </table>
- * <p>
+ *
* @since SmartDeviceLink 3.0
- * <p>
+ *
* @see SoftButtonCapabilities
* @see ButtonCapabilities
* @see OnButtonPress
@@ -61,12 +61,12 @@ public class TouchEvent extends RPCStruct { public TouchEvent() { }
/**
- * Constructs a new TouchEvent object indicated by the Hashtable parameter
- * <p>
+ * <p>Constructs a new TouchEvent object indicated by the Hashtable parameter</p>
+ *
*
* @param hash
* <p>
- * The Hashtable to use
+ * The Hashtable to use</p>
*/
public TouchEvent(Hashtable<String, Object> hash) {
super(hash);
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java index 57670e057..b67e5b61a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java @@ -5,8 +5,8 @@ import com.smartdevicelink.proxy.RPCStruct; import java.util.Hashtable;
/**
* Types of screen touch events available in screen area.
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java index 1bfb8652c..437e176a5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/Turn.java @@ -6,8 +6,8 @@ import com.smartdevicelink.proxy.RPCStruct; /** * Describes a navigation turn including an optional icon - * <p> - * <b>Parameter List + * + * <p><b>Parameter List</p> * <table border="1" rules="all"> * <tr> * <th>Name</th> diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java index d069a35f7..8db9e032f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterface.java @@ -10,14 +10,14 @@ import com.smartdevicelink.proxy.RPCRequest; * dispose of all resources associated with the application's interface
* registration (e.g. Command Menu items, Choice Sets, button subscriptions,
* etc.)
- * <p>
- * After the UnregisterAppInterface operation is performed, no other operations
+ *
+ * <p>After the UnregisterAppInterface operation is performed, no other operations
* can be performed until a new app interface registration is established by
- * calling <i>{@linkplain RegisterAppInterface}</i>
- * <p>
- * <b>HMILevel can be FULL, LIMITED, BACKGROUND or NONE</b>
- * </p>
- * <p><b>Parameter List</b>
+ * calling <i>{@linkplain RegisterAppInterface}</i></p>
+ *
+ * <p><b>HMILevel can be FULL, LIMITED, BACKGROUND or NONE</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -231,9 +231,9 @@ public class UnregisterAppInterface extends RPCRequest { super(FunctionID.UNREGISTER_APP_INTERFACE.toString());
}
/**
- * Constructs a new UnregisterAppInterface object indicated by the Hashtable
- * parameter
- * <p>
+ * <p>Constructs a new UnregisterAppInterface object indicated by the Hashtable
+ * parameter</p>
+ *
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java index db425a503..d77bf3b39 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnregisterAppInterfaceResponse.java @@ -22,7 +22,7 @@ public class UnregisterAppInterfaceResponse extends RPCResponse { /**
* Constructs a new UnregisterAppInterfaceResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java index 6759d45ab..33567a8af 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java @@ -9,13 +9,13 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; /**
* Deletes a subscription to button notifications for the specified button. For
* more information about button subscriptions, see {@linkplain SubscribeButton}
- * <p>
- * Application can unsubscribe from a button that is currently being pressed
- * (i.e. has not yet been released), but app will not get button event
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p>Application can unsubscribe from a button that is currently being pressed
+ * (i.e. has not yet been released), but app will not get button event</p>
+ *
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -34,19 +34,18 @@ import com.smartdevicelink.proxy.rpc.enums.ButtonName; * <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
- * <p>
- * <b>Response</b><br>
- * <p>
- * <b>Non-default Result Codes:</b><p>
- * - SUCCESS<br>
- * - INVALID_DATA<br>
- * - OUT_OF_MEMORY<br>
- * - TOO_MANY_PENDING_REQUESTS<br>
- * - APPLICATION_NOT_REGISTERED<br>
- * - GENERIC_ERROR <br>
- * - UNSUPPORTED_RESOURCE<br>
- * - IGNORED<br>
- * - REJECTED<br>
+ *
+ * <p> <b>Response</b></p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>UNSUPPORTED_RESOURCE</p>
+ * <p>IGNORED</p>
+ * <p>REJECTED</p>
* @since SmartDeviceLink 1.0
* @see SubscribeButton
*/
@@ -62,7 +61,7 @@ public class UnsubscribeButton extends RPCRequest { /**
* Constructs a new UnsubscribeButton object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java index 58f7326e1..7efc00955 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeButtonResponse.java @@ -22,7 +22,7 @@ public class UnsubscribeButtonResponse extends RPCResponse { /**
* Constructs a new UnsubscribeButtonResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java index a87bc7c1b..668b31fd9 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java @@ -8,12 +8,10 @@ import com.smartdevicelink.proxy.RPCRequest; /**
* This function is used to unsubscribe the notifications from the
* subscribeVehicleData function
- * <p>
- * Function Group: Location, VehicleInfo and DrivingChara
- * <p>
- * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
- * </p>
- * <p><b>Parameter List</b>
+ * <p>Function Group: Location, VehicleInfo and DrivingChara</p>
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
@@ -216,18 +214,17 @@ import com.smartdevicelink.proxy.RPCRequest; * <td>SmartDeviceLink 2.0 </td>
* </tr>
* </table>
- * <b> Response</b><br>
- * <p>
- *<b>Non-default Result Codes:</b><p>
- * - SUCCESS<br>
- * - WARNINGS<br>
- * - INVALID_DATA<br>
- * - OUT_OF_MEMORY<br>
- * - TOO_MANY_PENDING_REQUESTS<br>
- * - APPLICATION_NOT_REGISTERED<br>
- * - GENERIC_ERROR <br>
- * - IGNORED<br>
- * - DISALLOWED<br>
+ * <p><b> Response</b></p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>WARNINGS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED</p>
+ * <p>DISALLOWED</p>
*
* @since SmartDeviceLink 2.0
* @see SubscribeVehicleData
@@ -270,7 +267,7 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Constructs a new UnsubscribeVehicleData object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java index 30e9e88b0..92d9a46df 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java @@ -47,7 +47,7 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { /**
* Constructs a new UnsubscribeVehicleDataResponse object indicated by the Hashtable
* parameter
- * <p>
+ * <p></p>
*
* @param hash
* The Hashtable to use
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java index fd4f88fa8..ad2b41163 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/UpdateTurnList.java @@ -10,11 +10,11 @@ import com.smartdevicelink.proxy.RPCRequest; /** * Updates the list of next maneuvers, which can be requested by the user pressing the softbutton "Turns" on the * Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close - * <p> - * Function Group: Navigation - * <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * <p> + * + * <p>Function Group: Navigation</p> + * + * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> + * * * @since SmartDeviceLink 2.0 * @see ShowConstantTbt @@ -49,7 +49,7 @@ public class UpdateTurnList extends RPCRequest{ * @param turnList * a List<Turn> value representing a list of turns to be shown to the user * <p> - * <b>Notes: </b>Minsize=1; Maxsize=100 + * <b>Notes: </b>Minsize=1; Maxsize=100</p> */ public void setTurnList(List<Turn> turnList){ if(turnList != null){ @@ -119,7 +119,7 @@ public class UpdateTurnList extends RPCRequest{ * @param softButtons * a List<SoftButton> value * <p> - * <b>Notes: </b><br/> + * <b>Notes: </b></p> * <ul> * <li>If omitted on supported displays, the alert will not have any SoftButton</li> * <li>ArrayMin: 0</li> diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java index 60954a3fc..ef466d727 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleDataResult.java @@ -8,8 +8,8 @@ import com.smartdevicelink.proxy.rpc.enums.VehicleDataType; /**
*
* Individual published data request result.
- * <p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -48,8 +48,8 @@ public class VehicleDataResult extends RPCStruct { * </p>
*
* @param hash
- * <p>
- * The Hashtable to use
+ *
+ * <p>The Hashtable to use</p>
*/
public VehicleDataResult() { }
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java index 3aca0b6a2..3f30774c4 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VehicleType.java @@ -6,7 +6,7 @@ import com.smartdevicelink.proxy.RPCStruct; /**
* Describes the type of vehicle the mobile phone is connected with.
- * <p><b>Parameter List</b>
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java index 577b6466e..f195b4cae 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/VrHelpItem.java @@ -7,8 +7,8 @@ import com.smartdevicelink.util.DebugTool; /**
*
* VR help items i.e. the text strings to be displayed, and when pronounced by the user the recognition of any of which must trigger the corresponding VR command.
- *<p>
- * <p><b>Parameter List</b>
+ *
+ * <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
@@ -39,7 +39,7 @@ import com.smartdevicelink.util.DebugTool; * <td>Integer</td>
* <td>Position to display item in VR Help list</td>
* <td>N</td>
- * <td> minvalue=1<br>maxvalue=100</td>
+ * <td> minvalue=1; maxvalue=100</td>
* <td>SmartDeviceLink 2.3.2</td>
* </tr>
* </table>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java index 345aa9728..3f4076b11 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/AmbientLightStatus.java @@ -2,7 +2,7 @@ package com.smartdevicelink.proxy.rpc.enums; /** Reflects the status of the ambient light sensor.
*
* @since SmartDeviceLink 2.3.2
- * <p>
+ *
* @see SoftButtonCapabilities
* @see ButtonCapabilities
* @see OnButtonPress
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java index 2eb9f73b0..33f1f0f49 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonEventMode.java @@ -3,8 +3,8 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Indicates whether the button was depressed or released. A BUTTONUP event will
* always be preceded by a BUTTONDOWN event
- * <p>
- * @see SoftButtonCapabilities
+ *
+ * @see SoftButtonCapabilities
* @see OnButtonEvent
* @since SmartDeviceLink 1.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java index 2c5299e40..cc2852526 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/ButtonPressMode.java @@ -2,9 +2,9 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Indicates whether this is a LONG or SHORT button press.
- * <p>
+ * <p></p>
*@see ButtonEventMode
- * @since SmartDeviceLink 1.0
+ *@since SmartDeviceLink 1.0
*/
public enum ButtonPressMode {
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java index 2516342f1..4ff5a1bbb 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/DisplayType.java @@ -1,6 +1,6 @@ package com.smartdevicelink.proxy.rpc.enums;
/** The type of the display.
- * <p>
+ *
*
* @since SmartDevcieLink 1.0
*
@@ -8,9 +8,9 @@ package com.smartdevicelink.proxy.rpc.enums; public enum DisplayType {
/**
- * Center Information Display.<br>
+ * Center Information Display.
*This display type provides a 2-line x 20 character "dot matrix" display.
- *<p>
+ *
*/
CID("CID"),
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java index 704afd118..54e5ce8b8 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/FileType.java @@ -1,7 +1,7 @@ package com.smartdevicelink.proxy.rpc.enums;
/**
- * Enumeration listing possible file tpyes.
+ * Enumeration listing possible file types.
* @since SmartDeviceLink 2.0
*/
public enum FileType {
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java index 8f2da6991..8757a26ec 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/HMILevel.java @@ -4,7 +4,7 @@ import java.util.EnumSet; /**
* Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing "focus" to other applications (e.g. phone, other mobile applications, etc.)
- * <p>
+ *
* @since SmartDeviceLink 1.0
*/
public enum HMILevel {
@@ -17,7 +17,7 @@ public enum HMILevel { */
HMI_LIMITED("LIMITED"),
/**
- * App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:<br/>
+ * App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:
* <ul>
* <li>Operation {@linkplain com.smartdevicelink.proxy.rpc.AddCommand}</li>
* <li>Operation {@linkplain com.smartdevicelink.proxy.rpc.DeleteCommand}</li>
@@ -35,7 +35,7 @@ public enum HMILevel { */
HMI_BACKGROUND("BACKGROUND"),
/**
- * Application has been discovered by SDL, but application cannot send any requests or receive any notifications<br/>
+ * Application has been discovered by SDL, but application cannot send any requests or receive any notifications
* An HMILevel of NONE can also mean that the user has exited the application by saying "exit appname" or selecting "exit" from the application's menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SDL, except <i>{@linkplain com.smartdevicelink.proxy.rpc.UnregisterAppInterface}</li>
*/
HMI_NONE("NONE");
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java index c20bc7386..98b61a1f2 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java @@ -33,12 +33,12 @@ public enum InteractionMode { * recognized choice), the interaction becomes strictly, and irreversibly, a
* VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will
* no longer be honored)
- * <P>
- * The TriggerSource parameter of the
+ *
+ * <p>The TriggerSource parameter of the
* {@linkplain com.smartdevicelink.proxy.rpc.PerformInteraction} response will
* indicate which interaction mode the user finally chose to attempt the
* selection (even if the interaction did not end with a selection being
- * made)
+ * made)</P>
*/
BOTH;
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java index 95d069393..5f0a0b88f 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Language.java @@ -4,7 +4,7 @@ import java.util.EnumSet; /**
* Specifies the language to be used for TTS, VR, displayed messages/menus
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java index f76ef9b3d..2bf84744a 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/MediaClockFormat.java @@ -2,8 +2,8 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Indicates the format of the time displayed on the connected SDL unit.Format
- * description follows the following nomenclature:<br> Sp = Space<br> | = or <br>c =
- * character
+ * description follows the following nomenclature:<p> Sp = Space</p> <p>| = or </p><p>c =
+ * character</p>
*
* @since SmartDeviceLink 1.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java index 6a80ba0e1..870e4115e 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/Result.java @@ -3,7 +3,7 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Defines the possible result codes returned by SDL to the application in a
* Response to a requested operation
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
*/
@@ -13,7 +13,7 @@ public enum Result { */
SUCCESS,
/**
- * The data sent is invalid. For example:<br/>
+ * <p>The data sent is invalid. For example:</p>
* <ul>
* <li>Invalid Json syntax</li>
* <li>Parameters out of bounds (number or enum range)</li>
@@ -39,7 +39,7 @@ public enum Result { */
TOO_MANY_PENDING_REQUESTS,
/**
- * One of the provided IDs is not valid. For example:<br/>
+ * <p>One of the provided IDs is not valid. For example:</p>
* <ul>
* <li>CorrelationID</li>
* <li>CommandID</li>
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java index 8ccd467e3..29fa27020 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SoftButtonType.java @@ -1,13 +1,12 @@ package com.smartdevicelink.proxy.rpc.enums;
import java.util.EnumSet;
-/** The enumeration defines the types of the soft buttons to be displayed on UI component:<br>
-1) The text is displayed on the soft button<br>
-2) The image is displayed on the soft button<br
-3) Both image and text are displayed on the soft button.<br>
-* <p>
-* @since SmartDeviceLink 2.0
-*/
+/** The enumeration defines the types of the soft buttons to be displayed on UI component:<p>The text is displayed on the soft button</p>
+ *<p>The image is displayed on the soft button</p>
+ *<p>Both image and text are displayed on the soft button.</p>
+ *
+ * @since SmartDeviceLink 2.0
+ */
public enum SoftButtonType {
/** Text displayed
*
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java index 3e383a8c7..2b5d17740 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/SpeechCapabilities.java @@ -23,7 +23,7 @@ public enum SpeechCapabilities { LHPLUS_PHONEMES,
/**
- * The SDL platform can play pre-recorded sounds as part of a TTS operation.<br>(e.g. Speak, Alert, PerformInteraction, etc.).<br>
+ * The SDL platform can play pre-recorded sounds as part of a TTS operation.<p>(e.g. Speak, Alert, PerformInteraction, etc.).</p>
*/
PRE_RECORDED,
/**
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java index 15c45b5f7..cd9bf6dfe 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/UpdateMode.java @@ -2,7 +2,7 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Specifies what function should be performed on the media clock/counter
- * <p>
+ *
*
* @since SmartDeviceLink 1.0
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java index c0997c708..d7bca9fc7 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataNotificationStatus.java @@ -3,7 +3,7 @@ package com.smartdevicelink.proxy.rpc.enums; /**
* Reflects the status of a vehicle data notification.
* @since SmartDeviceLink 2.0
- * <p>
+ *
* @see SoftButtonCapabilities
* @see ButtonCapabilities
* @see OnButtonPress
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java index 51c42cb2a..45c2e7c11 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java @@ -2,7 +2,7 @@ package com.smartdevicelink.proxy.rpc.enums; /** Enumeration that describes possible result codes of a vehicle data entry request.
*
* @since SmartDeviceLink 2.0
- *<p>
+ *
*@see DIDResult
*@see ReadDID
*/
@@ -20,7 +20,7 @@ public enum VehicleDataResultCode { */
TRUNCATED_DATA,
- /** This vehicle data item is not allowed for this app .<br>The request is not authorized in local policies.
+ /** This vehicle data item is not allowed for this app .The request is not authorized in local policies.
*
*/
diff --git a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java index cd8f00ce8..546cf05b5 100644 --- a/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java +++ b/sdl_android_lib/src/com/smartdevicelink/proxy/rpc/enums/WiperStatus.java @@ -2,7 +2,7 @@ package com.smartdevicelink.proxy.rpc.enums; /** This enumeration reflects the status of the wipers.
*
* @since SmartDeviceLink 2.0
- * <p>
+ *
* @see GetVehicleData
* @see OnVehicleData
*/
|