part 2 a bunch of more files with added documentation

17 files changed, 63 insertions, 5 deletions

diff --git a/SmartDeviceLink/SDLConfiguration.h b/SmartDeviceLink/SDLConfiguration.h
index d5bfbb1c4..c53a69f5a 100644
--- a/SmartDeviceLink/SDLConfiguration.h
+++ b/SmartDeviceLink/SDLConfiguration.h
@@ -18,7 +18,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /// Contains information about the apps configurtion, such as lifecycle, lockscreen, encryption, etc.
-@interface SDLCoSDLCreateInteractionChoiceSet.hnfiguration : NSObject <NSCopying>
+@interface SDLConfiguration : NSObject <NSCopying>
 
 /**
  *  The lifecycle configuration.
diff --git a/SmartDeviceLink/SDLDeleteFile.h b/SmartDeviceLink/SDLDeleteFile.h
index 927d2a7cc..04e1814a1 100644
--- a/SmartDeviceLink/SDLDeleteFile.h
+++ b/SmartDeviceLink/SDLDeleteFile.h
@@ -17,6 +17,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLDeleteFile : SDLRPCRequest
 
+/// Convenience init to delete a file
+///
+/// @param fileName A file reference name
+/// @return An SDLDeleteFile object
 - (instancetype)initWithFileName:(NSString *)fileName;
 
 /**
diff --git a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
index 3bef8d740..6c77ff1fb 100644
--- a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
+++ b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
@@ -23,6 +23,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLDeleteInteractionChoiceSet : SDLRPCRequest
 
+/// Convenience init to delete a choice set.
+///
+/// @param choiceId A unique ID that identifies the Choice Set
+/// @return An SDLDeleteInteractionChoiceSet object
 - (instancetype)initWithId:(UInt32)choiceId;
 
 /**
diff --git a/SmartDeviceLink/SDLDeleteSubMenu.h b/SmartDeviceLink/SDLDeleteSubMenu.h
index c6562e924..e0783453c 100644
--- a/SmartDeviceLink/SDLDeleteSubMenu.h
+++ b/SmartDeviceLink/SDLDeleteSubMenu.h
@@ -21,6 +21,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLDeleteSubMenu : SDLRPCRequest
 
+/// Convenience init to delete a submenu.
+/// 
+/// @param menuId Identifies the SDLSubMenu to be delete
+/// @return An SDLDeleteSubMenu object
 - (instancetype)initWithId:(UInt32)menuId;
 
 /**
diff --git a/SmartDeviceLink/SDLDeleteWindowResponse.h b/SmartDeviceLink/SDLDeleteWindowResponse.h
index d068f0aea..e2308bd08 100644
--- a/SmartDeviceLink/SDLDeleteWindowResponse.h
+++ b/SmartDeviceLink/SDLDeleteWindowResponse.h
@@ -10,8 +10,12 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Response to DeleteWindow
+///
+/// @since RPC 6.0
 @interface SDLDeleteWindowResponse : SDLRPCResponse
 
 @end
 
 NS_ASSUME_NONNULL_END
+
diff --git a/SmartDeviceLink/SDLDeviceInfo.h b/SmartDeviceLink/SDLDeviceInfo.h
index ba43d32ee..f442c6574 100644
--- a/SmartDeviceLink/SDLDeviceInfo.h
+++ b/SmartDeviceLink/SDLDeviceInfo.h
@@ -10,6 +10,9 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface SDLDeviceInfo : SDLRPCStruct
 
+/// Convenience init. Object will contain all information about the connected device.
+///
+/// @return An SDLDeviceInfo object
 + (instancetype)currentDevice;
 
 /**
diff --git a/SmartDeviceLink/SDLDiagnosticMessage.h b/SmartDeviceLink/SDLDiagnosticMessage.h
index c4ede3b4a..c01ce4fa8 100644
--- a/SmartDeviceLink/SDLDiagnosticMessage.h
+++ b/SmartDeviceLink/SDLDiagnosticMessage.h
@@ -14,6 +14,12 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLDiagnosticMessage : SDLRPCRequest
 
+/// Convenience init.
+/// 
+/// @param targetId Name of target ECU
+/// @param length Length of message (in bytes)
+/// @param data Array of bytes comprising CAN message
+/// @return An SDLDiagnosticMessage object
 - (instancetype)initWithTargetId:(UInt16)targetId length:(UInt16)length data:(NSArray<NSNumber<SDLUInt> *> *)data;
 
 /**
diff --git a/SmartDeviceLink/SDLDialNumber.h b/SmartDeviceLink/SDLDialNumber.h
index 292ab7adc..838449e0c 100644
--- a/SmartDeviceLink/SDLDialNumber.h
+++ b/SmartDeviceLink/SDLDialNumber.h
@@ -14,6 +14,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLDialNumber : SDLRPCRequest
 
+/// Convenience init to initiate a dial number request.
+///
+/// @param number Up to 40 character string representing the phone number. All characters stripped except for '0'-'9', '*', '#', ',', ';', and '+'.
+/// @return An SDLDialNumber object
 - (instancetype)initWithNumber:(NSString *)number;
 
 /**
diff --git a/SmartDeviceLink/SDLDirection.h b/SmartDeviceLink/SDLDirection.h
index b35f4c644..7f21ca385 100644
--- a/SmartDeviceLink/SDLDirection.h
+++ b/SmartDeviceLink/SDLDirection.h
@@ -8,17 +8,17 @@
 
 #import "SDLEnum.h"
 
-/*
+/**
  *  A navigation direction.
  */
 typedef SDLEnum SDLDirection SDL_SWIFT_ENUM;
 
-/*
+/**
  *  Direction left
  */
 extern SDLDirection const SDLDirectionLeft;
 
-/*
+/**
  *  Direction right
  */
 extern SDLDirection const SDLDirectionRight;
diff --git a/SmartDeviceLink/SDLEncodedSyncPData.h b/SmartDeviceLink/SDLEncodedSyncPData.h
index 402147ca7..df7f1a4f7 100644
--- a/SmartDeviceLink/SDLEncodedSyncPData.h
+++ b/SmartDeviceLink/SDLEncodedSyncPData.h
@@ -4,7 +4,7 @@
 
 #import "SDLRPCRequest.h"
 
-/*
+/**
  *  Allows encoded data in the form of SyncP packets to be sent to the SYNC module. Legacy / v1 Protocol implementation; use SyncPData instead.
  *
  *  *** DEPRECATED ***
diff --git a/SmartDeviceLink/SDLEncryptionConfiguration.h b/SmartDeviceLink/SDLEncryptionConfiguration.h
index c116ceb22..8173ba655 100644
--- a/SmartDeviceLink/SDLEncryptionConfiguration.h
+++ b/SmartDeviceLink/SDLEncryptionConfiguration.h
@@ -14,6 +14,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// The encryption configuration data
 @interface SDLEncryptionConfiguration : NSObject <NSCopying>
 
 /**
diff --git a/SmartDeviceLink/SDLEnum.h b/SmartDeviceLink/SDLEnum.h
index d22bc44db..de26aed86 100644
--- a/SmartDeviceLink/SDLEnum.h
+++ b/SmartDeviceLink/SDLEnum.h
@@ -7,6 +7,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Compares two enums for equivalents
 typedef NSString* SDLEnum SDL_SWIFT_ENUM;
 
 @interface NSString (SDLEnum)
diff --git a/SmartDeviceLink/SDLEqualizerSettings.h b/SmartDeviceLink/SDLEqualizerSettings.h
index 64da62126..0f25dc1b5 100644
--- a/SmartDeviceLink/SDLEqualizerSettings.h
+++ b/SmartDeviceLink/SDLEqualizerSettings.h
@@ -11,6 +11,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLEqualizerSettings : SDLRPCStruct
 
+/// Convenience init.
+/// 
+/// @param channelId Read-only channel / frequency name
+/// @param channelSetting Reflects the setting, from 0%-100%.
 - (instancetype)initWithChannelId:(UInt8)channelId channelSetting:(UInt8)channelSetting;
 
 /**
diff --git a/SmartDeviceLink/SDLErrorConstants.h b/SmartDeviceLink/SDLErrorConstants.h
index 66a9c2a70..d01d4cebc 100644
--- a/SmartDeviceLink/SDLErrorConstants.h
+++ b/SmartDeviceLink/SDLErrorConstants.h
@@ -137,11 +137,21 @@ typedef NS_ENUM(NSInteger, SDLMenuManagerError) {
     SDLMenuManagerErrorRPCsFailed = -1
 };
 
+/// Errors associated with Choice Set class
 typedef NS_ENUM(NSInteger, SDLChoiceSetManagerError) {
+    /// The choice set has been deleted before it was presented
     SDLChoiceSetManagerErrorPendingPresentationDeleted = -1,
+
+    /// The choice set failed to delete
     SDLChoiceSetManagerErrorDeletionFailed = -2,
+
+    /// The upload failed
     SDLChoiceSetManagerErrorUploadFailed = -3,
+
+    /// The menu items failed to be created
     SDLChoiceSetManagerErrorFailedToCreateMenuItems = -4,
+
+    /// Invalid state
     SDLChoiceSetManagerErrorInvalidState = -5
 };
 
diff --git a/SmartDeviceLink/SDLFile.h b/SmartDeviceLink/SDLFile.h
index b1a75f3a8..200c83e75 100644
--- a/SmartDeviceLink/SDLFile.h
+++ b/SmartDeviceLink/SDLFile.h
@@ -13,6 +13,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Crates an SDLFile from a file
 @interface SDLFile : NSObject <NSCopying>
 
 /**
diff --git a/SmartDeviceLink/SDLFileManagerConfiguration.h b/SmartDeviceLink/SDLFileManagerConfiguration.h
index 693a4111f..7bf61df9f 100644
--- a/SmartDeviceLink/SDLFileManagerConfiguration.h
+++ b/SmartDeviceLink/SDLFileManagerConfiguration.h
@@ -12,6 +12,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// File manager configuration information
 @interface SDLFileManagerConfiguration : NSObject <NSCopying>
 
 /**
diff --git a/SmartDeviceLink/SDLFunctionID.h b/SmartDeviceLink/SDLFunctionID.h
index b9766714b..6596f752e 100644
--- a/SmartDeviceLink/SDLFunctionID.h
+++ b/SmartDeviceLink/SDLFunctionID.h
@@ -7,11 +7,22 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// The function IDs os each RPC
 @interface SDLFunctionID : NSObject
 
+/// A shared instance
 + (instancetype)sharedInstance;
 
+/// Gets the function name for a given function ID
+///
+/// @param functionID A function ID
+/// @returns An SDLRPCFunctionName
 - (nullable SDLRPCFunctionName)functionNameForId:(UInt32)functionID;
+
+
+/// Gets the function ID from a function name
+///
+/// @param functionName The RPC function name
 - (nullable NSNumber<SDLInt> *)functionIdForName:(SDLRPCFunctionName)functionName;
 
 @end