more documentation

20 files changed, 92 insertions, 11 deletions

diff --git a/SmartDeviceLink/SDLChoiceSetDelegate.h b/SmartDeviceLink/SDLChoiceSetDelegate.h
index 601d83e14..7ff4b0b40 100644
--- a/SmartDeviceLink/SDLChoiceSetDelegate.h
+++ b/SmartDeviceLink/SDLChoiceSetDelegate.h
@@ -15,19 +15,21 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// Delegate methods in the SDLChoiceSet
+/// Delegate for the the SDLChoiceSet.
 @protocol SDLChoiceSetDelegate <NSObject>
 
 /// Delegate method called after a choice set item was selected
-/// @param choiceSet the choice set displayed
-/// @param choice the item selected
-/// @param source the trigger source
-/// @param rowIndex the row of the selected choice
+///
+/// @param choiceSet The choice set displayed
+/// @param choice The item selected
+/// @param source The trigger source
+/// @param rowIndex The row of the selected choice
 - (void)choiceSet:(SDLChoiceSet *)choiceSet didSelectChoice:(SDLChoiceCell *)choice withSource:(SDLTriggerSource)source atRowIndex:(NSUInteger)rowIndex;
 
 /// Delegate method called on an error
-/// @param choiceSet the choice set displayed
-/// @param error the item selected
+///
+/// @param choiceSet TSDLAudioStreamManager.hhe choice set displayed
+/// @param error The error
 - (void)choiceSet:(SDLChoiceSet *)choiceSet didReceiveError:(NSError *)error;
 
 @end
diff --git a/SmartDeviceLink/SDLOnSyncPData.h b/SmartDeviceLink/SDLOnSyncPData.h
index 4383ba341..7b16ba171 100644
--- a/SmartDeviceLink/SDLOnSyncPData.h
+++ b/SmartDeviceLink/SDLOnSyncPData.h
@@ -12,9 +12,13 @@ NS_ASSUME_NONNULL_BEGIN
 @interface SDLOnSyncPData : SDLRPCNotification
 
 /// The url
+///
+/// Optional
 @property (nullable, strong, nonatomic) NSString *URL;
 
 /// How long until a timeout
+///
+/// Optional
 @property (nullable, strong, nonatomic) NSNumber<SDLInt> *Timeout;
 
 @end
diff --git a/SmartDeviceLink/SDLPermissionConstants.h b/SmartDeviceLink/SDLPermissionConstants.h
index 1ff832d48..ea36738cc 100644
--- a/SmartDeviceLink/SDLPermissionConstants.h
+++ b/SmartDeviceLink/SDLPermissionConstants.h
@@ -12,7 +12,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// NSString typedef
+///
+/// SDLPermissionRPCName: The name of the permission
 typedef NSString *SDLPermissionRPCName;
+
+/// NSUUID typedef
+///
+/// SDLPermissionObserverIdentifier: A unique identifier
 typedef NSUUID *SDLPermissionObserverIdentifier;
 
 /**
diff --git a/SmartDeviceLink/SDLRPCMessage.h b/SmartDeviceLink/SDLRPCMessage.h
index 436ebcdfa..c6b04071d 100644
--- a/SmartDeviceLink/SDLRPCMessage.h
+++ b/SmartDeviceLink/SDLRPCMessage.h
@@ -7,6 +7,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Parent class of all RPC messages.
+///
+/// Contains basic information about an RPC message.
 @interface SDLRPCMessage : SDLRPCStruct <NSCopying>
 
 /**
diff --git a/SmartDeviceLink/SDLRPCMessageType.h b/SmartDeviceLink/SDLRPCMessageType.h
index 383da11ff..155c39ad5 100644
--- a/SmartDeviceLink/SDLRPCMessageType.h
+++ b/SmartDeviceLink/SDLRPCMessageType.h
@@ -5,13 +5,14 @@
 
 /**
  The type of RPC message
-
- - SDLRPCMessageTypeRequest: A request from the app to the IVI system
- - SDLRPCMessageTypeResponse: A response from the IVI system to the app
- - SDLRPCMessageTypeNotification: A notification from the IVI system to the app
  */
 typedef NS_ENUM(Byte, SDLRPCMessageType) {
+    /// A request from the app to the IVI system
     SDLRPCMessageTypeRequest = 0,
+
+    /// A response from the IVI system to the app
     SDLRPCMessageTypeResponse,
+
+    /// A notification from the IVI system to the app
     SDLRPCMessageTypeNotification
 };
diff --git a/SmartDeviceLink/SDLRPCResponse.h b/SmartDeviceLink/SDLRPCResponse.h
index bdb69893a..7fc3b1e1f 100644
--- a/SmartDeviceLink/SDLRPCResponse.h
+++ b/SmartDeviceLink/SDLRPCResponse.h
@@ -8,6 +8,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Basic information that all RPC responses contain
 @interface SDLRPCResponse : SDLRPCMessage
 
 /**
diff --git a/SmartDeviceLink/SDLRPCStruct.h b/SmartDeviceLink/SDLRPCStruct.h
index 25db21f16..f6f5be5ab 100644
--- a/SmartDeviceLink/SDLRPCStruct.h
+++ b/SmartDeviceLink/SDLRPCStruct.h
@@ -10,6 +10,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLRPCStruct : NSObject <NSCopying>
 
+/// The store that contains RPC data
 @property (strong, nonatomic, readonly) NSMutableDictionary<NSString *, id> *store;
 @property (assign, nonatomic, getter=isPayloadProtected) BOOL payloadProtected;
 /**
diff --git a/SmartDeviceLink/SDLReadDID.h b/SmartDeviceLink/SDLReadDID.h
index 04a3982e8..a5ea8ee7c 100644
--- a/SmartDeviceLink/SDLReadDID.h
+++ b/SmartDeviceLink/SDLReadDID.h
@@ -21,6 +21,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLReadDID : SDLRPCRequest
 
+/// Convenience init
+///
+/// @param ecuNumber An ID of the vehicle module
+/// @param didLocation Raw data from vehicle data DID location(s)
+/// @return An SDLReadDID object
 - (instancetype)initWithECUName:(UInt16)ecuNumber didLocation:(NSArray<NSNumber<SDLUInt> *> *)didLocation;
 
 /**
diff --git a/SmartDeviceLink/SDLResetGlobalProperties.h b/SmartDeviceLink/SDLResetGlobalProperties.h
index f58196940..ddbadb9f3 100644
--- a/SmartDeviceLink/SDLResetGlobalProperties.h
+++ b/SmartDeviceLink/SDLResetGlobalProperties.h
@@ -27,6 +27,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLResetGlobalProperties : SDLRPCRequest
 
+/// Convenience init to reset global properties.
+///
+/// @param properties An array of one or more GlobalProperty enumeration elements
+/// @return An SDLResetGlobalProperties object
 - (instancetype)initWithProperties:(NSArray<SDLGlobalProperty> *)properties;
 
 /**
diff --git a/SmartDeviceLink/SDLSoftButtonState.h b/SmartDeviceLink/SDLSoftButtonState.h
index b9560d9c0..64767e1d6 100644
--- a/SmartDeviceLink/SDLSoftButtonState.h
+++ b/SmartDeviceLink/SDLSoftButtonState.h
@@ -48,6 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (strong, nonatomic, readonly) SDLSoftButton *softButton;
 
+/// Initializer unavailable
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingAudioManagerType.h b/SmartDeviceLink/SDLStreamingAudioManagerType.h
index fb0436dbd..1ec391ef7 100644
--- a/SmartDeviceLink/SDLStreamingAudioManagerType.h
+++ b/SmartDeviceLink/SDLStreamingAudioManagerType.h
@@ -8,6 +8,7 @@
 
 #import <Foundation/Foundation.h>
 
+/// Streaming audio manager
 @protocol SDLStreamingAudioManagerType <NSObject>
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingMediaManager.h b/SmartDeviceLink/SDLStreamingMediaManager.h
index 28e5abc5e..0998868a6 100644
--- a/SmartDeviceLink/SDLStreamingMediaManager.h
+++ b/SmartDeviceLink/SDLStreamingMediaManager.h
@@ -115,6 +115,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (assign, nonatomic) BOOL showVideoBackgroundDisplay;
 
+/// Initializer unavailable
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
index 015353350..ef3d44881 100644
--- a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
+++ b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
@@ -24,16 +24,31 @@ typedef NS_ENUM(NSInteger, SDLStreamingEncryptionFlag) {
     SDLStreamingEncryptionFlagAuthenticateAndEncrypt
 };
 
+/// Name of video stream start notification
 extern NSString *const SDLVideoStreamDidStartNotification;
+
+/// Name of video stream stop notification
 extern NSString *const SDLVideoStreamDidStopNotification;
+
+/// Name of video stream suspended notification
 extern NSString *const SDLVideoStreamSuspendedNotification;
 
+/// Name of audio stream start notification
 extern NSString *const SDLAudioStreamDidStartNotification;
+
+/// Name of audio stream stop notification
 extern NSString *const SDLAudioStreamDidStopNotification;
 
+/// Lockscreen will present notification
 extern NSString *const SDLLockScreenManagerWillPresentLockScreenViewController;
+
+/// Lockscreen did present notification
 extern NSString *const SDLLockScreenManagerDidPresentLockScreenViewController;
+
+/// Lockscreen will dismiss notification
 extern NSString *const SDLLockScreenManagerWillDismissLockScreenViewController;
+
+/// Lockscreen did dismiss notification
 extern NSString *const SDLLockScreenManagerDidDismissLockScreenViewController;
 
 typedef NSString SDLVideoStreamManagerState;
diff --git a/SmartDeviceLink/SDLTemplateColorScheme.h b/SmartDeviceLink/SDLTemplateColorScheme.h
index db51327a9..5f0c615b2 100644
--- a/SmartDeviceLink/SDLTemplateColorScheme.h
+++ b/SmartDeviceLink/SDLTemplateColorScheme.h
@@ -25,6 +25,13 @@ NS_ASSUME_NONNULL_BEGIN
 /// @param backgroundColor he background color to be used on the template
 /// @return An SDLTemplateColorScheme
 - (instancetype)initWithPrimaryRGBColor:(SDLRGBColor *)primaryColor secondaryRGBColor:(SDLRGBColor *)secondaryColor backgroundRGBColor:(SDLRGBColor *)backgroundColor;
+
+///  Convenience init
+///
+/// @param primaryColor This must always be your primary brand color
+/// @param secondaryColor This may be an accent or complimentary color to your primary brand color
+/// @param backgroundColor he background color to be used on the template
+/// @return An SDLTemplateColorScheme
 - (instancetype)initWithPrimaryColor:(UIColor *)primaryColor secondaryColor:(UIColor *)secondaryColor backgroundColor:(UIColor *)backgroundColor;
 
 /**
diff --git a/SmartDeviceLink/SDLTouch.h b/SmartDeviceLink/SDLTouch.h
index cead4adb2..a0234a5d8 100644
--- a/SmartDeviceLink/SDLTouch.h
+++ b/SmartDeviceLink/SDLTouch.h
@@ -10,8 +10,14 @@
 
 @class SDLTouchEvent;
 
+/// Enum: SDLTouchIdentifier
+///
+/// Identifies finger touch
 typedef enum {
+    /// Touch was first finger
     SDLTouchIdentifierFirstFinger = 0,
+
+    /// Touch was second finger
     SDLTouchIdentifierSecondFinger = 1
 } SDLTouchIdentifier;
 
diff --git a/SmartDeviceLink/SDLTouchManager.h b/SmartDeviceLink/SDLTouchManager.h
index bcf31fa0c..cd7e01cf4 100644
--- a/SmartDeviceLink/SDLTouchManager.h
+++ b/SmartDeviceLink/SDLTouchManager.h
@@ -87,6 +87,7 @@ typedef void(^SDLTouchEventHandler)(SDLTouch *touch, SDLTouchType type);
  */
 - (void)cancelPendingTouches;
 
+/// Initializer unavailable
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
diff --git a/SmartDeviceLink/SDLVoiceCommand.h b/SmartDeviceLink/SDLVoiceCommand.h
index b29ec6fd1..1ed0225bc 100644
--- a/SmartDeviceLink/SDLVoiceCommand.h
+++ b/SmartDeviceLink/SDLVoiceCommand.h
@@ -10,8 +10,12 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+The handler that will be called when the command is activated
+*/
 typedef void(^SDLVoiceCommandSelectionHandler)(void);
 
+/// Voice commands available for the user to speak and be recognized by the IVI's voice recognition engine.
 @interface SDLVoiceCommand : NSObject
 
 /**
diff --git a/SmartDeviceLink/SDLVrHelpItem.h b/SmartDeviceLink/SDLVrHelpItem.h
index caa0ea0f4..9587da9c1 100644
--- a/SmartDeviceLink/SDLVrHelpItem.h
+++ b/SmartDeviceLink/SDLVrHelpItem.h
@@ -12,8 +12,19 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface SDLVRHelpItem : SDLRPCStruct
 
+/// Convenience init to create a VR help item with the following parameters
+///
+/// @param text Text to display for VR Help item
+/// @param image Image for VR Help item
+/// @return An SDLVRHelpItem object
 - (instancetype)initWithText:(NSString *)text image:(nullable SDLImage *)image;
 
+/// Convenience init to create a VR help item with all parameters
+///
+/// @param text Text to display for VR Help item
+/// @param image Image for VR Help item
+/// @param position  Position to display item in VR Help list
+/// @return An SDLVRHelpItem object
 - (instancetype)initWithText:(NSString *)text image:(nullable SDLImage *)image position:(UInt8)position;
 
 /**
diff --git a/SmartDeviceLink/SDLWeatherAlert.h b/SmartDeviceLink/SDLWeatherAlert.h
index 29a7824e7..21d85456f 100644
--- a/SmartDeviceLink/SDLWeatherAlert.h
+++ b/SmartDeviceLink/SDLWeatherAlert.h
@@ -11,6 +11,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Contains information about a weather alert
+///
+/// @since RPC 5.1
 @interface SDLWeatherAlert : SDLRPCStruct
 
 /**
diff --git a/SmartDeviceLink/SDLWeatherData.h b/SmartDeviceLink/SDLWeatherData.h
index 56405ea6d..68ea63cdc 100644
--- a/SmartDeviceLink/SDLWeatherData.h
+++ b/SmartDeviceLink/SDLWeatherData.h
@@ -15,6 +15,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Contains information about the current weather
+///
+/// @since RPC 5.1
 @interface SDLWeatherData : SDLRPCStruct
 
 /**