no message

13 files changed, 186 insertions, 37 deletions

diff --git a/SmartDeviceLink/SDLArtwork.h b/SmartDeviceLink/SDLArtwork.h
index 6b9e7c9e1..43078894c 100644
--- a/SmartDeviceLink/SDLArtwork.h
+++ b/SmartDeviceLink/SDLArtwork.h
@@ -13,8 +13,13 @@
 
 @class SDLImage;
 
+/// Format of the Artwork
 typedef NS_ENUM(NSUInteger, SDLArtworkImageFormat) {
+
+    /// Image foramt: PNG
     SDLArtworkImageFormatPNG,
+
+    /// Image foramt: JPG
     SDLArtworkImageFormatJPG
 };
 
diff --git a/SmartDeviceLink/SDLChoiceCell.h b/SmartDeviceLink/SDLChoiceCell.h
index 5ca267dad..197f0190d 100644
--- a/SmartDeviceLink/SDLChoiceCell.h
+++ b/SmartDeviceLink/SDLChoiceCell.h
@@ -12,6 +12,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// A selectable item within an SDLChoiceSet
 @interface SDLChoiceCell: NSObject
 
 /**
diff --git a/SmartDeviceLink/SDLChoiceSet.h b/SmartDeviceLink/SDLChoiceSet.h
index 226fb0184..674033553 100644
--- a/SmartDeviceLink/SDLChoiceSet.h
+++ b/SmartDeviceLink/SDLChoiceSet.h
@@ -20,13 +20,17 @@ NS_ASSUME_NONNULL_BEGIN
  */
 typedef void (^SDLChoiceSetCanceledHandler)(void);
 
+/// The layout to use when a choice set is displayed
 typedef NS_ENUM(NSUInteger, SDLChoiceSetLayout) {
+    /// Menu items will be displayed in a list
     SDLChoiceSetLayoutList,
+
+    /// Menu items will be displayed as a tiled list
     SDLChoiceSetLayoutTiles,
 };
 
 /**
- The choice set to be displayed to the user.
+ The choice set to be displayed to the user. Contains a list of selectable options.
  */
 @interface SDLChoiceSet: NSObject
 
diff --git a/SmartDeviceLink/SDLErrorConstants.h b/SmartDeviceLink/SDLErrorConstants.h
index d01d4cebc..f6c7e27ab 100644
--- a/SmartDeviceLink/SDLErrorConstants.h
+++ b/SmartDeviceLink/SDLErrorConstants.h
@@ -88,23 +88,23 @@ typedef NS_ENUM(NSInteger, SDLFileManagerError) {
      *  The file manager could not find the local file.
      */
     SDLFileManagerErrorFileDoesNotExist = -5,
-    /*
+    /**
      *  The file upload was canceled.
      */
     SDLFileManagerUploadCanceled = -6,
-    /*
+    /**
      *  One or more of multiple files being uploaded or deleted failed.
      */
     SDLFileManagerMultipleFileUploadTasksFailed = -7,
-    /*
+    /**
      *  One or more of multiple files being uploaded or deleted failed.
      */
     SDLFileManagerMultipleFileDeleteTasksFailed = -8,
-    /*
+    /**
      *  The file data is nil or empty.
      */
     SDLFileManagerErrorFileDataMissing = -9,
-    /*
+    /**
      *  The file is a static icon, which cannot be uploaded
      */
     SDLFileManagerErrorStaticIcon = -10,
@@ -112,28 +112,25 @@ typedef NS_ENUM(NSInteger, SDLFileManagerError) {
 
 /**
  Errors associated with the ScreenManager class
-
- - SDLTextAndGraphicManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent
  */
 typedef NS_ENUM(NSInteger, SDLTextAndGraphicManagerError) {
+    /// A pending update was superseded by a newer requested update. The old update will not be sent
     SDLTextAndGraphicManagerErrorPendingUpdateSuperseded = -1
 };
 
 /**
  Errors associated with the ScreenManager class
-
- - SDLSoftButtonManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent
  */
 typedef NS_ENUM(NSInteger, SDLSoftButtonManagerError) {
+    /// A pending update was superseded by a newer requested update. The old update will not be sent
     SDLSoftButtonManagerErrorPendingUpdateSuperseded = -1
 };
 
 /**
  Errors associated with the ScreenManager class
-
- - SDLMenuManagerErrorRPCsFailed: Sending menu-related RPCs returned an error from the remote system
  */
 typedef NS_ENUM(NSInteger, SDLMenuManagerError) {
+    /// Sending menu-related RPCs returned an error from the remote system
     SDLMenuManagerErrorRPCsFailed = -1
 };
 
diff --git a/SmartDeviceLink/SDLFile.h b/SmartDeviceLink/SDLFile.h
index 200c83e75..4b2273dc9 100644
--- a/SmartDeviceLink/SDLFile.h
+++ b/SmartDeviceLink/SDLFile.h
@@ -65,6 +65,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (assign, nonatomic, readonly) BOOL isStaticIcon;
 
+/// Initializer unavailable
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
diff --git a/SmartDeviceLink/SDLFileManager.h b/SmartDeviceLink/SDLFileManager.h
index 5eae0ff4b..c53a5410b 100644
--- a/SmartDeviceLink/SDLFileManager.h
+++ b/SmartDeviceLink/SDLFileManager.h
@@ -18,6 +18,10 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// The handler that is called when the manager is set up or failed to set up with an error
+///
+/// @param success True if every request succeeded, false if any failed.
+/// @param error The error that occurred during the request if any occurred.
 typedef void (^SDLFileManagerStartupCompletionHandler)(BOOL success, NSError *__nullable error);
 
 
diff --git a/SmartDeviceLink/SDLLifecycleConfiguration.h b/SmartDeviceLink/SDLLifecycleConfiguration.h
index d91dc6bd3..f2b59301b 100644
--- a/SmartDeviceLink/SDLLifecycleConfiguration.h
+++ b/SmartDeviceLink/SDLLifecycleConfiguration.h
@@ -33,6 +33,7 @@ typedef NS_OPTIONS(NSUInteger, SDLSecondaryTransports) {
  */
 @interface SDLLifecycleConfiguration : NSObject <NSCopying>
 
+/// Initializer unavailable
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
diff --git a/SmartDeviceLink/SDLLockScreenConfiguration.h b/SmartDeviceLink/SDLLockScreenConfiguration.h
index 317beabe4..01e8efacf 100644
--- a/SmartDeviceLink/SDLLockScreenConfiguration.h
+++ b/SmartDeviceLink/SDLLockScreenConfiguration.h
@@ -13,16 +13,18 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  Describes when the lock screen should be shown.
-
- - SDLLockScreenConfigurationModeNever: The lock screen should never be shown. This should almost always mean that you will build your own lock screen.
- - SDLLockScreenConfigurationModeRequiredOnly: The lock screen should only be shown when it is required by the head unit.
- - SDLLockScreenConfigurationModeOptionalOrRequired: The lock screen should be shown when required by the head unit or when the head unit says that its optional, but *not* in other cases, such as before the user has interacted with your app on the head unit.
- - SDLLockScreenConfigurationModeAlways: The lock screen should always be shown after connection.
  */
 typedef NS_ENUM(NSUInteger, SDLLockScreenConfigurationDisplayMode) {
+    /// The lock screen should never be shown. This should almost always mean that you will build your own lock screen.
     SDLLockScreenConfigurationDisplayModeNever,
+
+    /// The lock screen should only be shown when it is required by the head unit.
     SDLLockScreenConfigurationDisplayModeRequiredOnly,
+
+    /// The lock screen should be shown when required by the head unit or when the head unit says that its optional, but *not* in other cases, such as before the user has interacted with your app on the head unit.
     SDLLockScreenConfigurationDisplayModeOptionalOrRequired,
+
+    /// The lock screen should always be shown after connection.
     SDLLockScreenConfigurationDisplayModeAlways
 };
 
diff --git a/SmartDeviceLink/SDLLogConstants.h b/SmartDeviceLink/SDLLogConstants.h
index f0d9751bc..f14a6c2e3 100644
--- a/SmartDeviceLink/SDLLogConstants.h
+++ b/SmartDeviceLink/SDLLogConstants.h
@@ -27,48 +27,55 @@ typedef NS_ENUM(NSUInteger, SDLLogBytesDirection) {
 
 /**
  Flags used for SDLLogLevel to provide correct enum values. This is purely for internal use.
-
- - SDLLogFlagVerbose:   Verbose level logging
- - SDLLogFlagDebug:     Debug level logging
- - SDLLogFlagWarning:   Warning level logging
- - SDLLogFlagError:     Error level logging.
  */
 typedef NS_OPTIONS(NSUInteger, SDLLogFlag) {
+    /// Error level logging
     SDLLogFlagError = 1 << 0,
+
+    /// Warning level logging
     SDLLogFlagWarning = 1 << 1,
+
+    /// Debug level logging
     SDLLogFlagDebug = 1 << 2,
+
+    /// Verbose level logging
     SDLLogFlagVerbose = 1 << 3,
 };
 
 /**
  An enum describing a level of logging.
-
- - SDLLogLevelDefault:  This is used to describe that a "specific" logging will instead use the global log level, for example, a module may use the global log level instead of its own by specifying this level.
- - SDLLogLevelOff:      This is used to describe a level that involves absolutely no logs being output.
- - SDLLogLevelError:    Only error level logs will be output.
- - SDLLogLevelWarning:  Both error and warning level logs will be output.
- - SDLLogLevelDebug:    Error, warning, and debug level logs will be output. This level will never be output in RELEASE environments.
- - SDLLogLevelVerbose:  All level logs will be output. This level will never be output in RELEASE environments.
  */
 typedef NS_ENUM(NSInteger, SDLLogLevel) {
+    /// This is used to describe that a "specific" logging will instead use the global log level, for example, a module may use the global log level instead of its own by specifying this level.
     SDLLogLevelDefault = -1,
+
+    /// This is used to describe a level that involves absolutely no logs being output.
     SDLLogLevelOff = 0,
+
+    /// Only error level logs will be output
     SDLLogLevelError = SDLLogFlagError,
+
+    /// Both error and warning level logs will be output
     SDLLogLevelWarning = (SDLLogFlagError | SDLLogFlagWarning),
+
+    /// Error, warning, and debug level logs will be output. This level will never be output in RELEASE environments
     SDLLogLevelDebug = (SDLLogFlagWarning | SDLLogFlagDebug),
+
+    /// All level logs will be output. This level will never be output in RELEASE environments
     SDLLogLevelVerbose = (SDLLogFlagDebug | SDLLogFlagVerbose)
 };
 
 /**
  The output format of logs; how they will appear when printed out into a string.
-
- - SDLLogFormatTypeSimple:      A bare-bones log format: `09:52:07:324 🔹 (SDL)Protocol – a random test i guess`
- - SDLLogFormatTypeDefault:     A middle detail default log format: `09:52:07:324 🔹 (SDL)Protocol:SDLV2ProtocolHeader:25 – Some log message`
- - SDLLogFormatTypeDetailed:    A very detailed log format: `09:52:07:324 🔹 DEBUG com.apple.main-thread:(SDL)Protocol:[SDLV2ProtocolHeader parse:]:74 – Some log message`
  */
 typedef NS_ENUM(NSUInteger, SDLLogFormatType) {
+    /// A bare-bones log format: `09:52:07:324 🔹 (SDL)Protocol – a random test i guess`
     SDLLogFormatTypeSimple,
+
+    ///  A middle detail default log format: `09:52:07:324 🔹 (SDL)Protocol:SDLV2ProtocolHeader:25 – Some log message`
     SDLLogFormatTypeDefault,
+
+    /// A very detailed log format: `09:52:07:324 🔹 DEBUG com.apple.main-thread:(SDL)Protocol:[SDLV2ProtocolHeader parse:]:74 – Some log message`
     SDLLogFormatTypeDetailed,
 };
 
diff --git a/SmartDeviceLink/SDLLogFilter.h b/SmartDeviceLink/SDLLogFilter.h
index b3511cc0e..42dbd1f38 100644
--- a/SmartDeviceLink/SDLLogFilter.h
+++ b/SmartDeviceLink/SDLLogFilter.h
@@ -24,6 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
 /// Optional
 @property (strong, nonatomic, readonly) SDLLogFilterBlock filter;
 
+/// Initializer unavailable
 - (instancetype)init NS_UNAVAILABLE;
 
 /**
diff --git a/SmartDeviceLink/SDLManager.h b/SmartDeviceLink/SDLManager.h
index 3262ff26d..d18fbb58e 100644
--- a/SmartDeviceLink/SDLManager.h
+++ b/SmartDeviceLink/SDLManager.h
@@ -101,12 +101,12 @@ typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error);
  */
 @property (copy, nonatomic, readonly) NSArray<__kindof NSOperation *> *pendingRPCTransactions;
 
-/**
- * Deprecated internal proxy object. This should only be accessed when the Manager is READY. This property may go to nil at any time.
- * The only reason to use this is to access the `putFileStream:withRequest:` method. All other functionality exists on managers in 4.3. This will be removed in 5.0 and the functionality replicated on `SDLFileManager`.
- */
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
+/**
+* Deprecated internal proxy object. This should only be accessed when the Manager is READY. This property may go to nil at any time.
+* The only reason to use this is to access the `putFileStream:withRequest:` method. All other functionality exists on managers in 4.3. This will be removed in 5.0 and the functionality replicated on `SDLFileManager`.
+*/
 @property (strong, nonatomic, readonly, nullable) SDLProxy *proxy;
 #pragma clang diagnostic pop
 
diff --git a/SmartDeviceLink/SDLManagerDelegate.h b/SmartDeviceLink/SDLManagerDelegate.h
index 66d38dc39..538b11023 100644
--- a/SmartDeviceLink/SDLManagerDelegate.h
+++ b/SmartDeviceLink/SDLManagerDelegate.h
@@ -16,6 +16,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// The manager's delegate
 @protocol SDLManagerDelegate <NSObject>
 
 /**
diff --git a/SmartDeviceLink/SDLNotificationConstants.h b/SmartDeviceLink/SDLNotificationConstants.h
index ef19ec270..4fd2cff79 100644
--- a/SmartDeviceLink/SDLNotificationConstants.h
+++ b/SmartDeviceLink/SDLNotificationConstants.h
@@ -116,68 +116,193 @@ extern SDLNotificationName const SDLDidUpdateProjectionView;
  *  NSNotification names associated with specific RPC responses.
  */
 #pragma mark - RPC responses
+/// Name for an AddCommand response RPC
 extern SDLNotificationName const SDLDidReceiveAddCommandResponse;
+
+/// Name for an AddSubMenu response RPC
 extern SDLNotificationName const SDLDidReceiveAddSubMenuResponse;
+
+/// Name for an Alert response RPC
 extern SDLNotificationName const SDLDidReceiveAlertResponse;
+
+/// Name for an AlertManeuver response RPC
 extern SDLNotificationName const SDLDidReceiveAlertManeuverResponse;
+
+/// Name for an ButtonPress response RPC
 extern SDLNotificationName const SDLDidReceiveButtonPressResponse;
+
+/// Name for an CancelInteraction response RPC
 extern SDLNotificationName const SDLDidReceiveCancelInteractionResponse;
+
+/// Name for an ChangeRegistration response RPC
 extern SDLNotificationName const SDLDidReceiveChangeRegistrationResponse;
+
+/// Name for an CloseApplication response RPC
 extern SDLNotificationName const SDLDidReceiveCloseApplicationResponse;
+
+/// Name for an CreateInteractionChoiceSet response RPC
 extern SDLNotificationName const SDLDidReceiveCreateInteractionChoiceSetResponse;
+
+/// Name for an CreateWindow response RPC
 extern SDLNotificationName const SDLDidReceiveCreateWindowResponse;
+
+/// Name for an DeleteCommand response RPC
 extern SDLNotificationName const SDLDidReceiveDeleteCommandResponse;
+
+/// Name for an DeleteFile response RPC
 extern SDLNotificationName const SDLDidReceiveDeleteFileResponse;
+
+/// Name for an DeleteInteractionChoiceSet response RPC
 extern SDLNotificationName const SDLDidReceiveDeleteInteractionChoiceSetResponse;
+
+/// Name for an DeleteSubmenu response RPC
 extern SDLNotificationName const SDLDidReceiveDeleteSubmenuResponse;
+
+/// Name for an DeleteWindow response RPC
 extern SDLNotificationName const SDLDidReceiveDeleteWindowResponse;
+
+/// Name for an DiagnosticMessage response RPC
 extern SDLNotificationName const SDLDidReceiveDiagnosticMessageResponse;
+
+/// Name for an DialNumber response RPC
 extern SDLNotificationName const SDLDidReceiveDialNumberResponse;
+
+/// Name for an EncodedSyncPData response RPC
 extern SDLNotificationName const SDLDidReceiveEncodedSyncPDataResponse;
+
+/// Name for an EndAudioPassThru response RPC
 extern SDLNotificationName const SDLDidReceiveEndAudioPassThruResponse;
+
+/// Name for an Generic response RPC
 extern SDLNotificationName const SDLDidReceiveGenericResponse;
+
+/// Name for an GetCloudAppProperties response RPC
 extern SDLNotificationName const SDLDidReceiveGetCloudAppPropertiesResponse;
+
+/// Name for an GetAppServiceData response RPC
 extern SDLNotificationName const SDLDidReceiveGetAppServiceDataResponse;
+
+/// Name for an GetDTCs response RPC
 extern SDLNotificationName const SDLDidReceiveGetDTCsResponse;
+
+/// Name for an GetFile response RPC
 extern SDLNotificationName const SDLDidReceiveGetFileResponse;
+
+/// Name for an GetInteriorVehicleData response RPC
 extern SDLNotificationName const SDLDidReceiveGetInteriorVehicleDataResponse;
+
+/// Name for an GetInteriorVehicleDataConsent response RPC
 extern SDLNotificationName const SDLDidReceiveGetInteriorVehicleDataConsentResponse;
+
+/// Name for an GetSystemCapabilities response RPC
 extern SDLNotificationName const SDLDidReceiveGetSystemCapabilitiesResponse;
+
+/// Name for an GetVehicleData response RPC
 extern SDLNotificationName const SDLDidReceiveGetVehicleDataResponse;
+
+/// Name for an GetWaypoints response RPC
 extern SDLNotificationName const SDLDidReceiveGetWaypointsResponse;
+
+/// Name for an ListFiles response RPC
 extern SDLNotificationName const SDLDidReceiveListFilesResponse;
+
+/// Name for an PerformAppServiceInteraction response RPC
 extern SDLNotificationName const SDLDidReceivePerformAppServiceInteractionResponse;
+
+/// Name for an PerformAudioPassThru response RPC
 extern SDLNotificationName const SDLDidReceivePerformAudioPassThruResponse;
+
+/// Name for an PerformInteraction response RPC
 extern SDLNotificationName const SDLDidReceivePerformInteractionResponse;
+
+/// Name for an PublishAppService response RPC
 extern SDLNotificationName const SDLDidReceivePublishAppServiceResponse;
+
+/// Name for an ReceivePutFile response RPC
 extern SDLNotificationName const SDLDidReceivePutFileResponse;
+
+/// Name for an ReceiveReadDID response RPC
 extern SDLNotificationName const SDLDidReceiveReadDIDResponse;
+
+/// Name for an RegisterAppInterface response RPC
 extern SDLNotificationName const SDLDidReceiveRegisterAppInterfaceResponse;
+
+/// Name for an ReleaseInteriorVehicleDataModule response RPC
 extern SDLNotificationName const SDLDidReceiveReleaseInteriorVehicleDataModuleResponse;
+
+/// Name for an ResetGlobalProperties response RPC
 extern SDLNotificationName const SDLDidReceiveResetGlobalPropertiesResponse;
+
+/// Name for an ScrollableMessage response RPC
 extern SDLNotificationName const SDLDidReceiveScrollableMessageResponse;
+
+/// Name for an SendHapticData response RPC
 extern SDLNotificationName const SDLDidReceiveSendHapticDataResponse;
+
+/// Name for an SendLocation response RPC
 extern SDLNotificationName const SDLDidReceiveSendLocationResponse;
+
+/// Name for an SetAppIcon response RPC
 extern SDLNotificationName const SDLDidReceiveSetAppIconResponse;
+
+/// Name for an SetCloudAppProperties response RPC
 extern SDLNotificationName const SDLDidReceiveSetCloudAppPropertiesResponse;
+
+/// Name for an SetDisplayLayout response RPC
 extern SDLNotificationName const SDLDidReceiveSetDisplayLayoutResponse;
+
+/// Name for an SetGlobalProperties response RPC
 extern SDLNotificationName const SDLDidReceiveSetGlobalPropertiesResponse;
+
+/// Name for an SetInteriorVehicleData response RPC
 extern SDLNotificationName const SDLDidReceiveSetInteriorVehicleDataResponse;
+
+/// Name for an SetMediaClockTimer response RPC
 extern SDLNotificationName const SDLDidReceiveSetMediaClockTimerResponse;
+
+/// Name for an ShowConstantTBT response RPC
 extern SDLNotificationName const SDLDidReceiveShowConstantTBTResponse;
+
+/// Name for an Show response RPC
 extern SDLNotificationName const SDLDidReceiveShowResponse;
+
+/// Name for an ShowAppMenu response RPC
 extern SDLNotificationName const SDLDidReceiveShowAppMenuResponse;
+
+/// Name for an Slider response RPC
 extern SDLNotificationName const SDLDidReceiveSliderResponse;
+
+/// Name for an Speak response RPC
 extern SDLNotificationName const SDLDidReceiveSpeakResponse;
+
+/// Name for an Subscribe response RPC
 extern SDLNotificationName const SDLDidReceiveSubscribeButtonResponse;
+
+/// Name for an SubscribeVehicleData response RPC
 extern SDLNotificationName const SDLDidReceiveSubscribeVehicleDataResponse;
+
+/// Name for an SubscribeWaypoints response RPC
 extern SDLNotificationName const SDLDidReceiveSubscribeWaypointsResponse;
+
+/// Name for an SyncPData response RPC
 extern SDLNotificationName const SDLDidReceiveSyncPDataResponse;
+
+/// Name for an UpdateTurnList response RPC
 extern SDLNotificationName const SDLDidReceiveUpdateTurnListResponse;
+
+/// Name for an UnpublishAppService response RPC
 extern SDLNotificationName const SDLDidReceiveUnpublishAppServiceResponse;
+
+/// Name for an UnregisterAppInterface response RPC
 extern SDLNotificationName const SDLDidReceiveUnregisterAppInterfaceResponse;
+
+/// Name for an UnsubscribeButton response RPC
 extern SDLNotificationName const SDLDidReceiveUnsubscribeButtonResponse;
+
+/// Name for an UnsubscribeVehicleData response RPC
 extern SDLNotificationName const SDLDidReceiveUnsubscribeVehicleDataResponse;
+
+/// Name for an UnsubscribeWaypoints response RPC
 extern SDLNotificationName const SDLDidReceiveUnsubscribeWaypointsResponse;
 
 /**