Merge branch 'feature/documentation' into develop

SmartDeviceLink-iOS/SmartDeviceLink/ISDLProxy.h

@@ -1,6 +1,6 @@
 //  ISDLProxy.h
 //
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
 
 
 #import "SDLProtocol.h"

SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.h

@@ -1,6 +1,6 @@
 //  SDLAbstractProtocol.h
 //
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
 
 
 #import "SDLInterfaceProtocol.h"

SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.m

@@ -1,45 +1,43 @@
 //  SDLAbstractProtocol.m
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 #import "SDLAbstractProtocol.h"
 
 @implementation SDLAbstractProtocol
 - (id)init {
-	if (self = [super init]) {
+    if (self = [super init]) {
         _debugConsoleGroupName = @"default";
-	}
-	return self;
+    }
+    return self;
 }
 
 - (void)sendStartSessionWithType:(SDLServiceType)serviceType {
-	[self doesNotRecognizeSelector:_cmd];
+    [self doesNotRecognizeSelector:_cmd];
 }
 
 - (void)sendEndSessionWithType:(SDLServiceType)serviceType sessionID:(Byte)sessionID {
-	[self doesNotRecognizeSelector:_cmd];
+    [self doesNotRecognizeSelector:_cmd];
 }
 
 - (void)sendRPCRequest:(SDLRPCRequest *)rpcRequest {
     [self doesNotRecognizeSelector:_cmd];
 }
 
 - (void)handleBytesFromTransport:(NSData *)receivedData {
-	[self doesNotRecognizeSelector:_cmd];
+    [self doesNotRecognizeSelector:_cmd];
 }
 
 
 #pragma - SDLTransportListener Implementation
 - (void)onTransportConnected {
-	[self.protocolDelegate onProtocolOpened];
+    [self.protocolDelegate onProtocolOpened];
 }
 
 - (void)onTransportDisconnected {
-	[self.protocolDelegate onProtocolClosed];
+    [self.protocolDelegate onProtocolClosed];
 }
 
 - (void)onDataReceived:(NSData *)receivedData {
-	[self handleBytesFromTransport:receivedData];
+    [self handleBytesFromTransport:receivedData];
 }
 
-@end
+@end

SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.h

@@ -1,6 +1,4 @@
 //  SDLAbstractTransport.h
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 @import Foundation;
 

SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.m

@@ -1,7 +1,4 @@
 //  SDLAbstractTransport.m
-//  SDLAbstractTransport.m
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 #import "SDLAbstractTransport.h"
 

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.h

@@ -1,21 +1,82 @@
 //  SDLAddCommand.h
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 
 #import "SDLRPCRequest.h"
 
 #import "SDLMenuParams.h"
 #import "SDLImage.h"
 
+
+/**
+ *
+ * This class will add a command to the application's Command Menu SDLMenuParams<br>
+ * <b>Note:</b> A command will be added to the end of the list of elements in
+ * the Command Menu under the following conditions:
+ * <li>When a SDLCommand is added with no SDLMenuParams value provided</li>
+ * <li>When a SDLMenuParams value is provided with a SDLMenuParam.position value
+ * greater than or equal to the number of menu items currently defined in the
+ * menu specified by the SDLMenuParam.parentID value</li>
+ * <br/>
+ * The set of choices which the application builds using SDLAddCommand can be a
+ * mixture of:
+ * <li>Choices having only VR synonym definitions, but no SDLMenuParams definitions
+ * </li>
+ * <li>Choices having only SDLMenuParams definitions, but no VR synonym definitions
+ * </li>
+ * <li>Choices having both SDLMenuParams and VR synonym definitions</li>
+ *
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b>
+ * </p>
+ * Since <b>SDL 1.0</b><br>
+ * see SDLDeleteCommand SDLAddSubMenu SDLDeleteSubMenu
+ */
 @interface SDLAddCommand : SDLRPCRequest {}
 
+/**
+ * Constructs a new SDLAddCommand object
+ */
 -(id) init;
+/**
+ *
+ * Constructs a new SDLAddCommand object indicated by the NSMutableDictionary
+ * parameter
+ *
+ *
+ * @param dict The NSMutableDictionary to use
+ */
 -(id) initWithDictionary:(NSMutableDictionary*) dict;
 
+/**
+ * @abstract an Unique Command ID that identifies the command
+ * @discussion Is returned in an <i>SDLOnCommand</i> notification to identify the command
+ * selected by the user
+ * <p>
+ * <b>Notes:</b> Min Value: 0; Max Value: 2000000000
+ */
 @property(strong) NSNumber* cmdID;
+/**
+ * @abstract a <I>SDLMenuParams</I> pointer which will defined the command and how
+ * it is added to the Command Menu
+ * @discussion  If provided, this will define the command and how it is added to the
+ * Command Menu<br/>
+ * If null, commands will not be accessible through the HMI application menu
+ */
 @property(strong) SDLMenuParams* menuParams;
+/**
+ * @abstract Voice Recognition Commands
+ * @discussion If provided, defines one or more VR phrases the recognition of any of
+ * which triggers the <i>SDLOnCommand</i> notification with this
+ * cmdID<br/>
+ * If null, commands will not be accessible by voice commands (when the user
+ * hits push-to-talk)
+ */
 @property(strong) NSMutableArray* vrCommands;
+/**
+ * @abstract an Image obj representing the Image obj shown along with a command
+ * @discussion If provided, defines the image to be be shown along with a  command
+ * Notes:   If omitted on supported displays, no (or the
+ *            default if applicable) icon will be displayed
+ */
 @property(strong) SDLImage* cmdIcon;
 
 @end

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.m

@@ -1,6 +1,6 @@
 //  SDLAddCommand.m
 //
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
 
 #import "SDLAddCommand.h"
 

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.h

@@ -1,10 +1,14 @@
 //  SDLAddCommandResponse.h
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 
 #import "SDLRPCResponse.h"
 
+
+/**
+ * SDLAddCommandResponse is sent, when SDLAddCommand has been called
+ *
+ * Since <b>SmartDeviceLink 1.0</b>
+ */
 @interface SDLAddCommandResponse : SDLRPCResponse {}
 
 -(id) init;

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.m

@@ -1,6 +1,4 @@
 //  SDLAddCommandResponse.m
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 #import "SDLAddCommandResponse.h"
 

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.h

@@ -1,17 +1,65 @@
 //  SDLAddSubMenu.h
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 
 #import "SDLRPCRequest.h"
 
+/**
+ * Add a SDLSubMenu to the Command Menu
+ * <p>
+ * A SDLSubMenu can only be added to the Top Level Menu (i.e.a SDLSubMenu cannot be
+ * added to a SDLSubMenu), and may only contain commands as children
+ * <p>
+ * <p>
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b>
+ * </p>
+ *
+ * Since <b>SmartDeviceLink 1.0</b><br>
+ * see SDLDeleteSubMenu SDLAddCommand SDLDeleteCommand
+ */
 @interface SDLAddSubMenu : SDLRPCRequest {}
 
+/**
+ * Constructs a new SDLAddSubMenu object
+ */
 -(id) init;
+/**
+ * Constructs a new SDLAddSubMenu object indicated by the NSMutableDictionary parameter
+ * <p>
+ *
+ * @param dict The NSMutableDictionary to use
+ */
 -(id) initWithDictionary:(NSMutableDictionary*) dict;
 
+/**
+ * @abstract a Menu ID that identifies a sub menu
+ * @discussion This value is used in
+ * <i>SDLAddCommand</i> to which SDLSubMenu is the parent of the command being added
+ * <p>
+ */
 @property(strong) NSNumber* menuID;
+/**
+ * @abstract a position of menu
+ * @discussion An NSNumber pointer 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/>
+ *            <ul>
+ *            <li>
+ *            Min Value: 0; Max Value: 1000</li>
+ *            <li>If position is greater or equal than the number of items
+ *            on top level, the sub menu will be appended by the end</li>
+ *            <li>If this parameter is omitted, the entry will be added at
+ *            the end of the list</li>
+ *            </ul>
+ */
 @property(strong) NSNumber* position;
+/**
+ * @abstract a menuName which is displayed representing this submenu item
+ * @discussion NSString which will be displayed representing this submenu item
+ */
 @property(strong) NSString* menuName;
 
 @end

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.m

@@ -1,6 +1,4 @@
 //  SDLAddSubMenu.m
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 #import "SDLAddSubMenu.h"
 

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.h

@@ -1,10 +1,12 @@
 //  SDLAddSubMenuResponse.h
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 
 #import "SDLRPCResponse.h"
 
+/**
+ * SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called
+ * Since <b>SmartDeviceLink 1.0</b>
+ */
 @interface SDLAddSubMenuResponse : SDLRPCResponse {}
 
 -(id) init;

SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.m

@@ -1,6 +1,4 @@
 //  SDLAddSubMenuResponse.m
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 #import "SDLAddSubMenuResponse.h"
 

SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.h

@@ -1,6 +1,5 @@
 //  SDLAirbagStatus.h
 //
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 
 #import "SDLRPCMessage.h"

SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.m

@@ -1,6 +1,4 @@
 //  SDLAirbagStatus.m
-//
-//  Copyright (c) 2014 Ford Motor Company. All rights reserved.
 
 #import "SDLAirbagStatus.h"