Add more documentation to SystemCapabilityType enums

1 files changed, 214 insertions, 32 deletions

diff --git a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java
index f5d50c716..476d05a19 100644
--- a/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java
+++ b/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java
@@ -7,93 +7,93 @@ package com.smartdevicelink.proxy.rpc.enums;
  * <table border="1" rules="all">
  * 		<tr>
  * 			<th>Enum Name</th>
- * 			<th>Type</th>
+ * 			<th>Return Type</th>
  * 			<th>Description</th>
- * 			<th>Async?</th>
+ * 			<th>Requires Async?</th>
  * 			<th>Notes</th>
  * 		</tr>
  * 		<tr>
  * 			<td>NAVIGATION</td>
  * 			<td>NavigationCapability</td>
  * 			<td>Returns Navigation Capabilities</td>
- * 			<td>Y</td>
+ * 			<td align=center>Y</td>
  * 			<td>Call is synchronous <strong>after</strong> initial call</td>
  * 		</tr>
  * 		<tr>
  * 			<td>PHONE_CALL</td>
  * 			<td>PhoneCapability</td>
  * 			<td>Returns Phone Capabilities</td>
- * 			<td>Y</td>
+ * 			<td align=center>Y</td>
  * 			<td>Call is synchronous <strong>after</strong> initial call</td>
  * 		</tr>
  * 		<tr>
  * 			<td>VIDEO_STREAMING</td>
  * 			<td>VideoStreamingCapability</td>
  * 			<td>Returns Video Streaming Capabilities</td>
- * 			<td>Y</td>
+ * 			<td align=center>Y</td>
  * 			<td>Call is synchronous <strong>after</strong> initial call</td>
  * 		</tr>
  * 		<tr>
  * 			<td>REMOTE_CONTROL</td>
  * 			<td>RemoteControlCapabilities</td>
  * 			<td>Returns Remote Control Capabilities</td>
- * 			<td>Y</td>
+ * 			<td align=center>Y</td>
  * 			<td>Call is synchronous <strong>after</strong> initial call</td>
  * 		</tr>
  * 		<tr>
  * 			<td>HMI</td>
  * 			<td>HMICapabilities</td>
  * 			<td>Returns HMI Capabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
  * 		</tr>
  * 		<tr>
  * 			<td>DISPLAY</td>
  * 			<td>DisplayCapabilities</td>
  * 			<td>Returns Display Capabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
  * 		</tr>
  * 		<tr>
  * 			<td>AUDIO_PASSTHROUGH</td>
  * 			<td>List<AudioPassThruCapabilities></td>
  * 			<td>Returns a List of AudioPassThruCapabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td>
  * 		</tr>
  * 		<tr>
  * 			<td>BUTTON</td>
  * 			<td>List<ButtonCapabilities></td>
  * 			<td>Returns a List of ButtonCapabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td>
  * 		</tr>
  * 		<tr>
  * 			<td>HMI_ZONE</td>
  * 			<td>HmiZoneCapabilities</td>
  * 			<td>Returns HmiZone Capabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
  * 		</tr>
  * 		<tr>
  * 			<td>PRESET_BANK</td>
  * 			<td>PresetBankCapabilities</td>
  * 			<td>Returns PresetBank Capabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
  * 		</tr>
  * 		<tr>
  * 			<td>SOFTBUTTON</td>
  * 			<td>List<SoftButtonCapabilities></td>
  * 			<td>Returns a List of SoftButtonCapabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td>
  * 		</tr>
  * 		<tr>
  * 			<td>SPEECH</td>
  * 			<td>SpeechCapabilities</td>
  * 			<td>Returns Speech Capabilities</td>
- * 			<td>N</td>
+ * 			<td align=center>N</td>
  * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
  * 		</tr>
  *
@@ -102,66 +102,217 @@ package com.smartdevicelink.proxy.rpc.enums;
 public enum SystemCapabilityType {
 
 	/**
-	 * Available Asynchronously, then synchronously after successful call <br>
-	 * Returns: Object that can be cast to NavigationCapability
+	 * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br>
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>NAVIGATION</td>
+	 * 			<td>NavigationCapability</td>
+	 * 			<td>Returns Navigation Capabilities</td>
+	 * 			<td align=center>Y</td>
+	 * 			<td>Call is synchronous <strong>after</strong> initial call</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     NAVIGATION,
 
 	/**
-	 * Available Asynchronously, then synchronously after successful call <br>
-	 * Returns: Object that can be cast to PhoneCapability
+	 * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br>
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>PHONE_CALL</td>
+	 * 			<td>PhoneCapability</td>
+	 * 			<td>Returns Phone Capabilities</td>
+	 * 			<td align=center>Y</td>
+	 * 			<td>Call is synchronous <strong>after</strong> initial call</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     PHONE_CALL,
 
 	/**
-	 * Available Asynchronously, then synchronously after successful call <br>
-	 * Returns: Object that can be cast to VideoStreamingCapability
+	 * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br>
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>VIDEO_STREAMING</td>
+	 * 			<td>VideoStreamingCapability</td>
+	 * 			<td>Returns Video Streaming Capabilities</td>
+	 * 			<td align=center>Y</td>
+	 * 			<td>Call is synchronous <strong>after</strong> initial call</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     VIDEO_STREAMING,
 
 	/**
-	 * Available Asynchronously, then synchronously after successful call <br>
-	 * Returns: Object that can be cast to RemoteControlCapabilities
+	 * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br>
+	 * 	<table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 			<td>REMOTE_CONTROL</td>
+	 * 			<td>RemoteControlCapabilities</td>
+	 * 			<td>Returns Remote Control Capabilities</td>
+	 * 			<td align=center>Y</td>
+	 * 			<td>Call is synchronous <strong>after</strong> initial call</td>
+	 * 		</tr>
+	 * 	</table>
+	 *
 	 */
     REMOTE_CONTROL,
 
-    /* These below aren’t actually part of the RPC spec. Only for Internal Proxy use */
+    /* These below are not part of the RPC spec. Only for Internal Proxy use */
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: Object that can be cast to HMICapabilities
+	 * 	 <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 *		<tr>
+	 * 			<td>HMI</td>
+	 * 			<td>HMICapabilities</td>
+	 * 			<td>Returns HMI Capabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     HMI,
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: Object that can be cast to DisplayCapabilities
+	 * Returns: DisplayCapabilities
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>DISPLAY</td>
+	 * 			<td>DisplayCapabilities</td>
+	 * 			<td>Returns Display Capabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response received</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     DISPLAY,
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: List<AudioPassThruCapabilities> <br>
-	 * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation
+	 * <b>Note:</b> @SuppressWarnings("unchecked") may be needed when casting depending on implementation
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>AUDIO_PASSTHROUGH</td>
+	 * 			<td>List<AudioPassThruCapabilities></td>
+	 * 			<td>Returns a List of AudioPassThruCapabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     AUDIO_PASSTHROUGH,
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: List<ButtonCapabilities> <br>
-	 * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation
+	 * <b>Note:</b> @SuppressWarnings("unchecked") may be needed when casting depending on implementation
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>BUTTON</td>
+	 * 			<td>List<ButtonCapabilities></td>
+	 * 			<td>Returns a List of ButtonCapabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     BUTTON,
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: Object that can be cast to HmiZoneCapabilities
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>HMI_ZONE</td>
+	 * 			<td>HmiZoneCapabilities</td>
+	 * 			<td>Returns HmiZone Capabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     HMI_ZONE,
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: Object that can be cast to PresetBankCapabilities
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>PRESET_BANK</td>
+	 * 			<td>PresetBankCapabilities</td>
+	 * 			<td>Returns PresetBank Capabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     PRESET_BANK,
 
@@ -169,12 +320,43 @@ public enum SystemCapabilityType {
 	 * Available Synchronously after Register App Interface response <br>
 	 * Returns: List<SoftButtonCapabilities> <br>
 	 * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>SOFTBUTTON</td>
+	 * 			<td>List<SoftButtonCapabilities></td>
+	 * 			<td>Returns a List of SoftButtonCapabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     SOFTBUTTON,
 
 	/**
 	 * Available Synchronously after Register App Interface response <br>
-	 * Returns: Object that can be cast to SpeechCapabilities
+	 * <table border="1" rules="all">
+	 * 		<tr>
+	 * 			<th>Enum Name</th>
+	 * 			<th>Return Type</th>
+	 * 			<th>Description</th>
+	 * 			<th>Requires Async?</th>
+	 * 			<th>Notes</th>
+	 * 		</tr>
+	 * 		<tr>
+	 * 			<td>SPEECH</td>
+	 * 			<td>SpeechCapabilities</td>
+	 * 			<td>Returns Speech Capabilities</td>
+	 * 			<td align=center>N</td>
+	 * 			<td>Available Synchronously <strong>after</strong> Register App Interface response</td>
+	 * 		</tr>
+	 * 	</table>
 	 */
     SPEECH;