summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h
diff options
context:
space:
mode:
authorJoel Fischer <joel@livio.io>2015-04-23 09:57:12 -0400
committerJoel Fischer <joel@livio.io>2015-04-23 09:57:12 -0400
commit819fb866b0c087c801b616762d6d3881e846ad1b (patch)
tree06d6d77991b0f61031117bd263cd7556adf50bf3 /SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h
parent80ccacf4851f1a614fe41ccb8d89dafff5f78595 (diff)
downloadsdl_ios-819fb866b0c087c801b616762d6d3881e846ad1b.tar.gz
Lots of documentation updates and fixes
* Enables documentation warnings in Xcode * Fixes every warning given by Xcode * Most files that contained a warning was also updated with formatting, content, and grammar fixes
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h65
1 files changed, 22 insertions, 43 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h
index d1c603acc..88d2094e7 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h
@@ -7,47 +7,8 @@
/**
* Contains information about a SoftButton's capabilities.
- * <p><b>Parameter List
- * <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>shortPressAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports a short press.
- * Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>longPressAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports a LONG press.
- * Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>upDownAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
- * Whenever the button is released, onButtonEvent( UP) will be invoked. *
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>imageSupported</td>
- * <td>Boolean</td>
- * <td>The button supports referencing a static or dynamic image.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * </table>
- * Since SmartDeviceLink 2.0
+ *
+ * @since SDL 2.0
*/
@interface SDLSoftButtonCapabilities : SDLRPCStruct {}
@@ -55,26 +16,44 @@
* @abstract Constructs a newly allocated SDLSoftButtonCapabilities object
*/
-(instancetype) init;
+
/**
- * @abstract Constructs a newly allocated SDLSoftButtonCapabilities object indicated by the NSMutableDictionary parameter
- * @param dict The NSMutableDictionary to use
+ * @abstract Constructs a newly allocated SDLSoftButtonCapabilities object indicated by the dictionary parameter
+ * @param dict The dictionary to use
*/
-(instancetype) initWithDictionary:(NSMutableDictionary*) dict;
/**
* @abstract The button supports a short press.
+ *
+ * @discussion Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.
+ *
+ * Required, Boolean
*/
@property(strong) NSNumber* shortPressAvailable;
+
/**
* @abstract The button supports a LONG press.
+ *
+ * @discussion Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.
+ *
+ * Required, Boolean
*/
@property(strong) NSNumber* longPressAvailable;
+
/**
* @abstract The button supports "button down" and "button up".
+ *
+ * @discussion Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.
+ *
+ * Required, Boolean
*/
@property(strong) NSNumber* upDownAvailable;
+
/**
* @abstract The button supports referencing a static or dynamic image.
+ *
+ * Required, Boolean
*/
@property(strong) NSNumber* imageSupported;