1 files changed, 92 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h
index bd3150358..bed791623 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h
@@ -1,6 +1,6 @@
 //  SDLOnButtonEvent.h
 //
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
 
 
 #import "SDLRPCNotification.h"
@@ -8,12 +8,103 @@
 #import "SDLButtonName.h"
 #import "SDLButtonEventMode.h"
 
+/**
+ * Notifies application that user has depressed or released a button to which
+ * the application has subscribed.</br> Further information about button events
+ * and button-presses can be found at <i>SDLSubscribeButton</i>.
+ * <p>
+ * </p>
+ * <b>HMI Status Requirements:</b>
+ * <ul>
+ * HMILevel:
+ * <ul>
+ * <li>The application will receive <i>SDLOnButtonEvent</i> notifications for all
+ * subscribed buttons when HMILevel is FULL.</li>
+ * <li>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed
+ * media buttons when HMILevel is LIMITED.</li>
+ * <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and
+ * PRESET_0-PRESET_9.</li>
+ * <li>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel
+ * is BACKGROUND.</li>
+ * </ul>
+ * AudioStreamingState:
+ * <ul>
+ * <li> Any </li>
+ * </ul>
+ * SystemContext:
+ * <ul>
+ * <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable
+ * button will cancel VR.</li>
+ * </ul>
+ * </ul>
+ * <p>
+ * <b>Parameter List:</b>
+ * <table  border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Req</th>
+ * <th>Notes</th>
+ * <th>SmartDeviceLink Ver Available</th>
+ * </tr>
+ * <tr>
+ * <td>buttonName</td>
+ * <td>SDLButtonName* </td>
+ * <td>Name of the button which triggered this event</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>buttonEventMode</td>
+ * <td>SDLButtonEventMode* </td>
+ * <td>Indicats button was depressed (DOWN) or released (UP)</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>customButtonID</td>
+ * <td>NSNumber* </td>
+ * <td>If SDLButtonName is “CUSTOM_BUTTON", this references the integer ID passed
+ * by a custom button. (e.g. softButton ID)</td>
+ * <td>N</td>
+ * <td>Minvalue=0 Maxvalue=65536</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * </table>
+ * </p>
+ *
+ * Since <b>SmartDeviceLink 1.0</b><br>
+ *
+ * see SDLSubscribeButton SDLUnsubscribeButton
+ */
 @interface SDLOnButtonEvent : SDLRPCNotification {}
 
+/**
+ *Constructs a newly allocated SDLOnButtonEvent object
+ */
 -(id) init;
+/**
+ * <p>
+ * Constructs a newly allocated SDLOnButtonEvent object indicated by the
+ * NSMutableDictionary parameter
+ * </p>
+ *
+ * @param dict The NSMutableDictionary to use
+ */
 -(id) initWithDictionary:(NSMutableDictionary*) dict;
 
+/**
+ * @abstract the name of the button
+ * @discussion
+ */
 @property(strong) SDLButtonName* buttonName;
+/**
+ * @abstract button event indicates the button was depressed or released
+ * @discussion
+ */
 @property(strong) SDLButtonEventMode* buttonEventMode;
 @property(strong) NSNumber* customButtonID;