summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Gluck <justin.gluck@livio.io>2019-10-29 10:49:15 -0400
committerJustin Gluck <justin.gluck@livio.io>2019-10-29 10:49:15 -0400
commit8910a2b659de33b0e774b1eda2ddd9040e5d965f (patch)
treec654f14c68403b8f800a99dcae6936225147c0aa
parent9066591c2c7db52e138baedf2f742006d6e347c8 (diff)
downloadsdl_ios-8910a2b659de33b0e774b1eda2ddd9040e5d965f.tar.gz
adding tons of documentation
-rw-r--r--SmartDeviceLink/SDLAddSubMenu.h26
-rw-r--r--SmartDeviceLink/SDLAlertManeuver.h10
-rw-r--r--SmartDeviceLink/SDLAlertResponse.h3
-rw-r--r--SmartDeviceLink/SDLAppInfo.h2
-rw-r--r--SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h6
-rw-r--r--SmartDeviceLink/SDLAppServiceCapability.h4
-rw-r--r--SmartDeviceLink/SDLAppServiceData.h4
-rw-r--r--SmartDeviceLink/SDLAppServiceRecord.h4
-rw-r--r--SmartDeviceLink/SDLAppServicesCapabilities.h4
-rw-r--r--SmartDeviceLink/SDLArtwork.h3
-rw-r--r--SmartDeviceLink/SDLAudioControlCapabilities.h5
-rw-r--r--SmartDeviceLink/SDLAudioControlData.h5
-rw-r--r--SmartDeviceLink/SDLAudioControlData.m1
-rwxr-xr-xSmartDeviceLink/SDLAudioFile.h3
-rwxr-xr-xSmartDeviceLink/SDLAudioStreamManager.h3
-rw-r--r--SmartDeviceLink/SDLButtonName.h12
-rw-r--r--SmartDeviceLink/SDLButtonPress.h26
-rw-r--r--SmartDeviceLink/SDLCancelInteraction.h2
-rw-r--r--SmartDeviceLink/SDLChangeRegistration.h20
-rw-r--r--SmartDeviceLink/SDLChoice.h24
-rw-r--r--SmartDeviceLink/SDLChoiceSet.h3
-rw-r--r--SmartDeviceLink/SDLChoiceSetDelegate.h10
-rw-r--r--SmartDeviceLink/SDLClimateControlCapabilities.h68
-rw-r--r--SmartDeviceLink/SDLClimateControlData.h46
-rw-r--r--SmartDeviceLink/SDLCloudAppProperties.h2
-rw-r--r--SmartDeviceLink/SDLConfiguration.h3
-rw-r--r--SmartDeviceLink/SDLCreateInteractionChoiceSet.h4
-rw-r--r--SmartDeviceLink/SDLCreateWindowResponse.h3
-rw-r--r--SmartDeviceLink/SDLDateTime.h34
-rw-r--r--SmartDeviceLink/SDLDeleteCommand.h4
30 files changed, 323 insertions, 21 deletions
diff --git a/SmartDeviceLink/SDLAddSubMenu.h b/SmartDeviceLink/SDLAddSubMenu.h
index 338ecd645..4a9dcc9a6 100644
--- a/SmartDeviceLink/SDLAddSubMenu.h
+++ b/SmartDeviceLink/SDLAddSubMenu.h
@@ -25,12 +25,38 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAddSubMenu : SDLRPCRequest
+
+/// Convenience init to create a new add sub menu.
+///
+/// @param menuId A menu id
+/// @param menuName The menu name
+/// @return An instance of the add submenu class
- (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName;
+/// Convenience init to create a new add sub menu.
+///
+/// @param menuId A menu id
+/// @param menuName The menu name
+/// @param position The position within the menu to add
+/// @return An SDLAddSubMenu object
- (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName position:(UInt8)position __deprecated_msg("Use initWithId:menuName:menuLayout:menuIcon:position: instead");
+/// Convenience init to create a new add sub menu.
+///
+/// @param menuId A menu id
+/// @param menuName The menu name
+/// @param icon The icon to show on the menu item
+/// @param position The position within the menu to add
+/// @return An SDLAddSubMenu object
- (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName menuIcon:(nullable SDLImage *)icon position:(UInt8)position __deprecated_msg("Use initWithId:menuName:menuLayout:menuIcon:position: instead");
+/// Convenience init to create a new add sub menu with all properties.
+/// @param menuId A menu id
+/// @param menuName The menu name
+/// @param menuLayout The sub-menu layout
+/// @param icon The icon to show on the menu item
+/// @param position The position within the menu to add
+/// @return An SDLAddSubMenu object
- (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName menuLayout:(nullable SDLMenuLayout)menuLayout menuIcon:(nullable SDLImage *)icon position:(UInt8)position;
/**
diff --git a/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink/SDLAlertManeuver.h
index afb0e51e1..cf79561bd 100644
--- a/SmartDeviceLink/SDLAlertManeuver.h
+++ b/SmartDeviceLink/SDLAlertManeuver.h
@@ -18,7 +18,17 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAlertManeuver : SDLRPCRequest
+/// Create a new alert maneuver with these parameters
+///
+/// @param ttsText The text to speak
+/// @param softButtons An arry of soft buttons
+/// @return An instance of the alert maneuver class
- (instancetype)initWithTTS:(nullable NSString *)ttsText softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
+
+/// Create a new alert maneuver with these parameters
+/// @param ttsChunks An array of text chunks
+/// @param softButtons An arry of soft buttons
+/// @return An instance of the alert maneuver class
- (instancetype)initWithTTSChunks:(nullable NSArray<SDLTTSChunk *> *)ttsChunks softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
/**
diff --git a/SmartDeviceLink/SDLAlertResponse.h b/SmartDeviceLink/SDLAlertResponse.h
index 771d666e1..281a7341d 100644
--- a/SmartDeviceLink/SDLAlertResponse.h
+++ b/SmartDeviceLink/SDLAlertResponse.h
@@ -14,6 +14,9 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAlertResponse : SDLRPCResponse
+/// Amount of time (in seconds) that an app must wait before resending an alert.
+///
+/// @since 2.0
@property (nullable, strong, nonatomic) NSNumber<SDLInt> *tryAgainTime;
@end
diff --git a/SmartDeviceLink/SDLAppInfo.h b/SmartDeviceLink/SDLAppInfo.h
index c73064de8..1caee38fa 100644
--- a/SmartDeviceLink/SDLAppInfo.h
+++ b/SmartDeviceLink/SDLAppInfo.h
@@ -10,6 +10,8 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLAppInfo : SDLRPCStruct
+/// Create a new app info
+/// @return An instance of the app info class
+ (instancetype)currentAppInfo;
/**
diff --git a/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h b/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
index 1c9b5b8b9..8b30c6438 100644
--- a/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
+++ b/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
@@ -64,6 +64,12 @@ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReason
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonAppUnauthorized;
+/// The app could not register due to a protocol violation
+///
+/// @since RPC 4.0
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonProtocolViolation;
+/// The HMI resource is unsupported
+///
+/// @since RPC 4.1
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonUnsupportedHMIResource;
diff --git a/SmartDeviceLink/SDLAppServiceCapability.h b/SmartDeviceLink/SDLAppServiceCapability.h
index a842dddd1..803f82c7c 100644
--- a/SmartDeviceLink/SDLAppServiceCapability.h
+++ b/SmartDeviceLink/SDLAppServiceCapability.h
@@ -13,8 +13,10 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
* A currently available service.
+ *
+ * @since RPC 5.1
*/
@interface SDLAppServiceCapability : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLAppServiceData.h b/SmartDeviceLink/SDLAppServiceData.h
index 7e6a96d4c..28a6121b9 100644
--- a/SmartDeviceLink/SDLAppServiceData.h
+++ b/SmartDeviceLink/SDLAppServiceData.h
@@ -17,8 +17,10 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
* Contains all the current data of the app service. The serviceType will link to which of the service data objects are included in this object (e.g. if the service type is MEDIA, the mediaServiceData param should be included).
+ *
+ * @since RPC 5.1
*/
@interface SDLAppServiceData : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLAppServiceRecord.h b/SmartDeviceLink/SDLAppServiceRecord.h
index 1d78d61ed..fd5a3bf37 100644
--- a/SmartDeviceLink/SDLAppServiceRecord.h
+++ b/SmartDeviceLink/SDLAppServiceRecord.h
@@ -13,8 +13,10 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
* This is the record of an app service publisher that the module has. It should contain the most up to date information including the service's active state.
+ *
+ * @since RPC 5.1
*/
@interface SDLAppServiceRecord : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLAppServicesCapabilities.h b/SmartDeviceLink/SDLAppServicesCapabilities.h
index 707a10acb..feb843c30 100644
--- a/SmartDeviceLink/SDLAppServicesCapabilities.h
+++ b/SmartDeviceLink/SDLAppServicesCapabilities.h
@@ -12,8 +12,10 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
* Capabilities of app services including what service types are supported and the current state of services.
+ *
+ * @since RPC 5.1
*/
@interface SDLAppServicesCapabilities : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLArtwork.h b/SmartDeviceLink/SDLArtwork.h
index cf7b68d13..6b9e7c9e1 100644
--- a/SmartDeviceLink/SDLArtwork.h
+++ b/SmartDeviceLink/SDLArtwork.h
@@ -20,6 +20,9 @@ typedef NS_ENUM(NSUInteger, SDLArtworkImageFormat) {
NS_ASSUME_NONNULL_BEGIN
+/**
+ A type of SDLFile image
+ */
@interface SDLArtwork : SDLFile
/**
diff --git a/SmartDeviceLink/SDLAudioControlCapabilities.h b/SmartDeviceLink/SDLAudioControlCapabilities.h
index d91bef2ef..119bce447 100644
--- a/SmartDeviceLink/SDLAudioControlCapabilities.h
+++ b/SmartDeviceLink/SDLAudioControlCapabilities.h
@@ -6,6 +6,11 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ Current audio control capabilitie. If included, the platform supports audio controls
+
+ @since RPC 5.0
+ */
@interface SDLAudioControlCapabilities : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLAudioControlData.h b/SmartDeviceLink/SDLAudioControlData.h
index 3261b4266..2cd996338 100644
--- a/SmartDeviceLink/SDLAudioControlData.h
+++ b/SmartDeviceLink/SDLAudioControlData.h
@@ -8,6 +8,11 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ The audio control data information.
+
+ @since RPC 5.0
+ */
@interface SDLAudioControlData : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLAudioControlData.m b/SmartDeviceLink/SDLAudioControlData.m
index 67296c9ae..0e5e86d7e 100644
--- a/SmartDeviceLink/SDLAudioControlData.m
+++ b/SmartDeviceLink/SDLAudioControlData.m
@@ -15,7 +15,6 @@ NS_ASSUME_NONNULL_BEGIN
if (!self) {
return nil;
}
-
self.source = source;
self.keepContext = keepContext;
self.volume = volume;
diff --git a/SmartDeviceLink/SDLAudioFile.h b/SmartDeviceLink/SDLAudioFile.h
index 794c50cab..a9302949b 100755
--- a/SmartDeviceLink/SDLAudioFile.h
+++ b/SmartDeviceLink/SDLAudioFile.h
@@ -10,6 +10,9 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ Includes inforamtion about a given audio file
+ */
@interface SDLAudioFile : NSObject
/**
diff --git a/SmartDeviceLink/SDLAudioStreamManager.h b/SmartDeviceLink/SDLAudioStreamManager.h
index b405cae5d..a2f364c87 100755
--- a/SmartDeviceLink/SDLAudioStreamManager.h
+++ b/SmartDeviceLink/SDLAudioStreamManager.h
@@ -23,6 +23,9 @@ typedef NS_ENUM(NSInteger, SDLAudioStreamManagerError) {
SDLAudioStreamManagerErrorNoQueuedAudio = -2
};
+/**
+ The manager to control the audio stream
+ */
@interface SDLAudioStreamManager : NSObject
/**
diff --git a/SmartDeviceLink/SDLButtonName.h b/SmartDeviceLink/SDLButtonName.h
index 2badd1635..4f6007fb5 100644
--- a/SmartDeviceLink/SDLButtonName.h
+++ b/SmartDeviceLink/SDLButtonName.h
@@ -255,32 +255,32 @@ extern SDLButtonName const SDLButtonNameNavPanDown;
*/
extern SDLButtonName const SDLButtonNameNavPanDownLeft;
-/*
+/**
* Represents a Pan left button
*/
extern SDLButtonName const SDLButtonNameNavPanLeft;
-/*
+/**
* Represents a Pan up left button
*/
extern SDLButtonName const SDLButtonNameNavPanUpLeft;
-/*
+/**
* Represents a Tilt button. If supported, this toggles between a top-down view and an angled/3D view. If your app supports different, but substantially similar options, then you may implement those. If you don't implement these or similar options, do not subscribe to this button.
*/
extern SDLButtonName const SDLButtonNameNavTiltToggle;
-/*
+/**
* Represents a Rotate clockwise button
*/
extern SDLButtonName const SDLButtonNameNavRotateClockwise;
-/*
+/**
* Represents a Rotate counterclockwise button
*/
extern SDLButtonName const SDLButtonNameNavRotateCounterClockwise;
-/*
+/**
* Represents a Heading toggle button. If supported, this toggles between locking the orientation to north or to the vehicle's heading. If your app supports different, but substantially similar options, then you may implement those. If you don't implement these or similar options, do not subscribe to this button.
*/
extern SDLButtonName const SDLButtonNameNavHeadingToggle;
diff --git a/SmartDeviceLink/SDLButtonPress.h b/SmartDeviceLink/SDLButtonPress.h
index 3d251f87d..56b9bcadd 100644
--- a/SmartDeviceLink/SDLButtonPress.h
+++ b/SmartDeviceLink/SDLButtonPress.h
@@ -7,16 +7,34 @@
#import "SDLButtonName.h"
#import "SDLButtonPressMode.h"
-/**
- * This RPC allows a remote control type mobile application to simulate a hardware button press event.
- */
-
NS_ASSUME_NONNULL_BEGIN
+/**
+ This RPC allows a remote control type mobile application to simulate a hardware button press event.
+
+ @since RPC 4.5
+*/
@interface SDLButtonPress : SDLRPCRequest
+/**
+Constructs a newly allocated SDLButtonPress object with the given parameters
+
+@param buttonName the name of the button
+@param moduleType the module where the button should be pressed
+
+@return An instance of the SDLButtonPress class.
+*/
- (instancetype)initWithButtonName:(SDLButtonName)buttonName moduleType:(SDLModuleType)moduleType __deprecated_msg(("Use initWithButtonName:moduleType:moduleId: instead"));;
+/**
+Constructs a newly allocated SDLButtonPress object with the given parameters
+
+@param buttonName the name of the button
+@param moduleType the module where the button should be pressed
+@param moduleId the id of the module
+
+@return An instance of the SDLButtonPress class.
+*/
- (instancetype)initWithButtonName:(SDLButtonName)buttonName moduleType:(SDLModuleType)moduleType moduleId:(nullable NSString *)moduleId;
/**
diff --git a/SmartDeviceLink/SDLCancelInteraction.h b/SmartDeviceLink/SDLCancelInteraction.h
index d8f9078d2..20b097699 100644
--- a/SmartDeviceLink/SDLCancelInteraction.h
+++ b/SmartDeviceLink/SDLCancelInteraction.h
@@ -10,7 +10,7 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
Used to dismiss a modal view programmatically without needing to wait for the timeout to complete. Can be used to dismiss alerts, scrollable messages, sliders, and perform interactions (i.e. pop-up menus).
@see SDLAlert, SDLScrollableMessage, SDLSlider, SDLPerformInteraction
diff --git a/SmartDeviceLink/SDLChangeRegistration.h b/SmartDeviceLink/SDLChangeRegistration.h
index 9f5e2e26b..8d4f223a8 100644
--- a/SmartDeviceLink/SDLChangeRegistration.h
+++ b/SmartDeviceLink/SDLChangeRegistration.h
@@ -19,8 +19,28 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLChangeRegistration : SDLRPCRequest
+/**
+Constructs a newly allocated SDLChangeRegistration object with the given parameters
+
+@param language the name of the button
+@param hmiDisplayLanguage the module where the button should be pressed
+
+@return An instance of the SDLChangeRegistration class.
+*/
- (instancetype)initWithLanguage:(SDLLanguage)language hmiDisplayLanguage:(SDLLanguage)hmiDisplayLanguage;
+/**
+Constructs a newly allocated SDLChangeRegistration object with the given parameters
+
+@param language the language the app wants to change to
+@param hmiDisplayLanguage HMI display language
+@param appName request a new app name registration
+@param ttsName request a new TTSName registration
+@param ngnMediaScreenAppName request a new app short name registration
+@param vrSynonyms request a new VR synonyms registration
+
+@return An instance of the SDLChangeRegistration class.
+*/
- (instancetype)initWithLanguage:(SDLLanguage)language hmiDisplayLanguage:(SDLLanguage)hmiDisplayLanguage appName:(nullable NSString *)appName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName ngnMediaScreenAppName:(nullable NSString *)ngnMediaScreenAppName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms;
/**
diff --git a/SmartDeviceLink/SDLChoice.h b/SmartDeviceLink/SDLChoice.h
index 9abdb5630..b62539e2d 100644
--- a/SmartDeviceLink/SDLChoice.h
+++ b/SmartDeviceLink/SDLChoice.h
@@ -9,14 +9,36 @@
/**
* A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
*
- * Since SmartDeviceLink 1.0
+ * Since RPC 1.0
*/
NS_ASSUME_NONNULL_BEGIN
@interface SDLChoice : SDLRPCStruct
+/**
+Constructs a newly allocated SDLChangeRegistration object with the given parameters
+
+@param choiceId the application-scoped identifier that uniquely identifies this choice
+@param menuName text which appears in menu, representing this choice
+@param vrCommands vr synonyms for this choice
+
+@return An instance of the SDLChangeRegistration class.
+*/
- (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(nullable NSArray<NSString *> *)vrCommands;
+/**
+Constructs a newly allocated SDLChangeRegistration object with the given parameters
+
+@param choiceId the application-scoped identifier that uniquely identifies this choice
+@param menuName text which appears in menu, representing this choice
+@param vrCommands vr synonyms for this choice
+@param image the image of the choice
+@param secondaryText secondary text to display; e.g. address of POI in a search result entry
+@param secondaryImage secondary image for choice
+@param tertiaryText tertiary text to display; e.g. distance to POI for a search result entry
+
+@return An instance of the SDLChangeRegistration class.
+*/
- (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(nullable NSArray<NSString *> *)vrCommands image:(nullable SDLImage *)image secondaryText:(nullable NSString *)secondaryText secondaryImage:(nullable SDLImage *)secondaryImage tertiaryText:(nullable NSString *)tertiaryText;
/**
diff --git a/SmartDeviceLink/SDLChoiceSet.h b/SmartDeviceLink/SDLChoiceSet.h
index f93fbc7df..226fb0184 100644
--- a/SmartDeviceLink/SDLChoiceSet.h
+++ b/SmartDeviceLink/SDLChoiceSet.h
@@ -25,6 +25,9 @@ typedef NS_ENUM(NSUInteger, SDLChoiceSetLayout) {
SDLChoiceSetLayoutTiles,
};
+/**
+ The choice set to be displayed to the user.
+ */
@interface SDLChoiceSet: NSObject
/**
diff --git a/SmartDeviceLink/SDLChoiceSetDelegate.h b/SmartDeviceLink/SDLChoiceSetDelegate.h
index 22c9f9d8b..601d83e14 100644
--- a/SmartDeviceLink/SDLChoiceSetDelegate.h
+++ b/SmartDeviceLink/SDLChoiceSetDelegate.h
@@ -15,9 +15,19 @@
NS_ASSUME_NONNULL_BEGIN
+/// Delegate methods in 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
- (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
- (void)choiceSet:(SDLChoiceSet *)choiceSet didReceiveError:(NSError *)error;
@end
diff --git a/SmartDeviceLink/SDLClimateControlCapabilities.h b/SmartDeviceLink/SDLClimateControlCapabilities.h
index 99ad8fece..351b8dd79 100644
--- a/SmartDeviceLink/SDLClimateControlCapabilities.h
+++ b/SmartDeviceLink/SDLClimateControlCapabilities.h
@@ -14,12 +14,80 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLClimateControlCapabilities : SDLRPCStruct
+/// Convenience init to describe the climate control capabilities.
+///
+/// @param moduleName The short friendly name of the climate control module
+/// @param fanSpeedAvailable Availability of the control of fan speed
+/// @param desiredTemperatureAvailable Availability of the control of desired temperature
+/// @param acEnableAvailable Availability of the control of turn on/off AC
+/// @param acMaxEnableAvailable Availability of the control of enable/disable air conditioning is ON on the maximum level
+/// @param circulateAirEnableAvailable Availability of the control of enable/disable circulate Air mode
+/// @param autoModeEnableAvailable Availability of the control of enable/disable auto mode
+/// @param dualModeEnableAvailable Availability of the control of enable/disable dual mode
+/// @param defrostZoneAvailable Availability of the control of defrost zones
+/// @param ventilationModeAvailable Availability of the control of air ventilation mode
+/// @return An SDLClimateControlCapabilities object
- (instancetype)initWithModuleName:(NSString *)moduleName fanSpeedAvailable:(BOOL)fanSpeedAvailable desiredTemperatureAvailable:(BOOL)desiredTemperatureAvailable acEnableAvailable:(BOOL)acEnableAvailable acMaxEnableAvailable:(BOOL)acMaxEnableAvailable circulateAirAvailable:(BOOL)circulateAirEnableAvailable autoModeEnableAvailable:(BOOL)autoModeEnableAvailable dualModeEnableAvailable:(BOOL)dualModeEnableAvailable defrostZoneAvailable:(BOOL)defrostZoneAvailable ventilationModeAvailable:(BOOL)ventilationModeAvailable __deprecated_msg("Use initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable: dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable: heatedSteeringWheelAvailable:heatedWindshieldAvailable: heatedRearWindowAvailable:heatedMirrorsAvailable: climateEnableAvailable: instead");
+
+/// Convenience init to describe the climate control capabilities.
+///
+/// @param moduleName The short friendly name of the climate control module
+/// @param fanSpeedAvailable Availability of the control of fan speed
+/// @param desiredTemperatureAvailable Availability of the control of desired temperature
+/// @param acEnableAvailable Availability of the control of turn on/off AC
+/// @param acMaxEnableAvailable Availability of the control of enable/disable air conditioning is ON on the maximum level
+/// @param circulateAirEnableAvailable Availability of the control of enable/disable circulate Air mode
+/// @param autoModeEnableAvailable Availability of the control of enable/disable auto mode
+/// @param dualModeEnableAvailable Availability of the control of enable/disable dual mode
+/// @param defrostZoneAvailable Availability of the control of defrost zones
+/// @param ventilationModeAvailable Availability of the control of air ventilation mode
+/// @param heatedSteeringWheelAvailable Availability of the control (enable/disable) of heated Steering Wheel
+/// @param heatedWindshieldAvailable Availability of the control (enable/disable) of heated Windshield
+/// @param heatedRearWindowAvailable Availability of the control (enable/disable) of heated Rear Window
+/// @param heatedMirrorsAvailable Availability of the control (enable/disable) of heated Mirrors
+/// @return An SDLClimateControlCapabilities object
- (instancetype)initWithModuleName:(NSString *)moduleName fanSpeedAvailable:(BOOL)fanSpeedAvailable desiredTemperatureAvailable:(BOOL)desiredTemperatureAvailable acEnableAvailable:(BOOL)acEnableAvailable acMaxEnableAvailable:(BOOL)acMaxEnableAvailable circulateAirAvailable:(BOOL)circulateAirEnableAvailable autoModeEnableAvailable:(BOOL)autoModeEnableAvailable dualModeEnableAvailable:(BOOL)dualModeEnableAvailable defrostZoneAvailable:(BOOL)defrostZoneAvailable ventilationModeAvailable:(BOOL)ventilationModeAvailable heatedSteeringWheelAvailable:(BOOL)heatedSteeringWheelAvailable heatedWindshieldAvailable:(BOOL)heatedWindshieldAvailable heatedRearWindowAvailable:(BOOL)heatedRearWindowAvailable heatedMirrorsAvailable:(BOOL)heatedMirrorsAvailable __deprecated_msg("Use initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable: dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable: heatedSteeringWheelAvailable:heatedWindshieldAvailable: heatedRearWindowAvailable:heatedMirrorsAvailable: climateEnableAvailable: instead");
+/// Convenience init to describe the climate control capabilities.
+///
+/// @param moduleName The short friendly name of the climate control module
+/// @param fanSpeedAvailable Availability of the control of fan speed
+/// @param desiredTemperatureAvailable Availability of the control of desired temperature
+/// @param acEnableAvailable Availability of the control of turn on/off AC
+/// @param acMaxEnableAvailable Availability of the control of enable/disable air conditioning is ON on the maximum level
+/// @param circulateAirEnableAvailable Availability of the control of enable/disable circulate Air mode
+/// @param autoModeEnableAvailable Availability of the control of enable/disable auto mode
+/// @param dualModeEnableAvailable Availability of the control of enable/disable dual mode
+/// @param defrostZoneAvailable Availability of the control of defrost zones
+/// @param ventilationModeAvailable Availability of the control of air ventilation mode
+/// @param heatedSteeringWheelAvailable Availability of the control (enable/disable) of heated Steering Wheel
+/// @param heatedWindshieldAvailable Availability of the control (enable/disable) of heated Windshield
+/// @param heatedRearWindowAvailable Availability of the control (enable/disable) of heated Rear Window
+/// @param heatedMirrorsAvailable Availability of the control (enable/disable) of heated Mirrors
+/// @param climateEnableAvailable Availability of the control of enable/disable climate control
+/// @return An SDLClimateControlCapabilities object
- (instancetype)initWithModuleName:(NSString *)moduleName fanSpeedAvailable:(BOOL)fanSpeedAvailable desiredTemperatureAvailable:(BOOL)desiredTemperatureAvailable acEnableAvailable:(BOOL)acEnableAvailable acMaxEnableAvailable:(BOOL)acMaxEnableAvailable circulateAirAvailable:(BOOL)circulateAirEnableAvailable autoModeEnableAvailable:(BOOL)autoModeEnableAvailable dualModeEnableAvailable:(BOOL)dualModeEnableAvailable defrostZoneAvailable:(BOOL)defrostZoneAvailable ventilationModeAvailable:(BOOL)ventilationModeAvailable heatedSteeringWheelAvailable:(BOOL)heatedSteeringWheelAvailable heatedWindshieldAvailable:(BOOL)heatedWindshieldAvailable heatedRearWindowAvailable:(BOOL)heatedRearWindowAvailable heatedMirrorsAvailable:(BOOL)heatedMirrorsAvailable climateEnableAvailable:(BOOL)climateEnableAvailable __deprecated_msg("Use initWithModuleName: moduleId:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable: dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable: heatedSteeringWheelAvailable:heatedWindshieldAvailable: heatedRearWindowAvailable:heatedMirrorsAvailable: climateEnableAvailable: instead");
+/// Convenience init to describe the climate control capabilities with all properities.
+///
+/// @param moduleName The short friendly name of the climate control module.
+/// @param moduleInfo Information about a RC module, including its id
+/// @param fanSpeedAvailable Availability of the control of fan speed
+/// @param desiredTemperatureAvailable Availability of the control of desired temperature
+/// @param acEnableAvailable Availability of the control of turn on/off AC
+/// @param acMaxEnableAvailable Availability of the control of enable/disable air conditioning is ON on the maximum level
+/// @param circulateAirEnableAvailable Availability of the control of enable/disable circulate Air mode.
+/// @param autoModeEnableAvailable Availability of the control of enable/disable auto mode
+/// @param dualModeEnableAvailable Availability of the control of enable/disable dual mode
+/// @param defrostZoneAvailable Availability of the control of defrost zones
+/// @param ventilationModeAvailable Availability of the control of air ventilation mode
+/// @param heatedSteeringWheelAvailable Availability of the control (enable/disable) of heated Steering Wheel
+/// @param heatedWindshieldAvailable Availability of the control (enable/disable) of heated Windshield
+/// @param heatedRearWindowAvailable Availability of the control (enable/disable) of heated Rear Window
+/// @param heatedMirrorsAvailable Availability of the control (enable/disable) of heated Mirrors
+/// @param climateEnableAvailable Availability of the control of enable/disable climate control
+/// @return An SDLClimateControlCapabilities object
- (instancetype)initWithModuleName:(NSString *)moduleName moduleInfo:(nullable SDLModuleInfo *)moduleInfo fanSpeedAvailable:(BOOL)fanSpeedAvailable desiredTemperatureAvailable:(BOOL)desiredTemperatureAvailable acEnableAvailable:(BOOL)acEnableAvailable acMaxEnableAvailable:(BOOL)acMaxEnableAvailable circulateAirAvailable:(BOOL)circulateAirEnableAvailable autoModeEnableAvailable:(BOOL)autoModeEnableAvailable dualModeEnableAvailable:(BOOL)dualModeEnableAvailable defrostZoneAvailable:(BOOL)defrostZoneAvailable ventilationModeAvailable:(BOOL)ventilationModeAvailable heatedSteeringWheelAvailable:(BOOL)heatedSteeringWheelAvailable heatedWindshieldAvailable:(BOOL)heatedWindshieldAvailable heatedRearWindowAvailable:(BOOL)heatedRearWindowAvailable heatedMirrorsAvailable:(BOOL)heatedMirrorsAvailable climateEnableAvailable:(BOOL)climateEnableAvailable;
/**
diff --git a/SmartDeviceLink/SDLClimateControlData.h b/SmartDeviceLink/SDLClimateControlData.h
index 7d430d188..f811967d5 100644
--- a/SmartDeviceLink/SDLClimateControlData.h
+++ b/SmartDeviceLink/SDLClimateControlData.h
@@ -16,10 +16,52 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLClimateControlData : SDLRPCStruct
+/// Convenience init for climate control data.
+/// @param fanSpeed Speed of Fan in integer
+/// @param desiredTemperature Desired Temperature in SDLTemperature
+/// @param acEnable Represents if AC is enabled
+/// @param circulateAirEnable Represents if circulation of air is enabled
+/// @param autoModeEnable Represents if auto mode is enabled
+/// @param defrostZone Represents the kind of defrost zone
+/// @param dualModeEnable Represents if dual mode is enabled
+/// @param acMaxEnable Represents if ac max is enabled
+/// @param ventilationMode Represents the kind of ventilation zone
+/// @return An SDLClimateControlData object
- (instancetype)initWithFanSpeed:(nullable NSNumber<SDLInt> *)fanSpeed desiredTemperature:(nullable SDLTemperature *)desiredTemperature acEnable:(nullable NSNumber<SDLBool> *)acEnable circulateAirEnable:(nullable NSNumber<SDLBool> *)circulateAirEnable autoModeEnable:(nullable NSNumber<SDLBool> *)autoModeEnable defrostZone:(nullable SDLDefrostZone)defrostZone dualModeEnable:(nullable NSNumber<SDLBool> *)dualModeEnable acMaxEnable:(nullable NSNumber<SDLBool> *)acMaxEnable ventilationMode:(nullable SDLVentilationMode)ventilationMode __deprecated_msg("Use initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone: dualModeEnable:acMaxEnable:ventilationMode:heatedSteeringWheelEnable: heatedWindshieldEnable:heatedRearWindowEnable:heatedMirrorsEnable:climateEnable instead");
+/// Convenience init for climate control data.
+/// @param fanSpeed Speed of Fan in integer
+/// @param desiredTemperature Desired Temperature in SDLTemperature
+/// @param acEnable Represents if AC is enabled
+/// @param circulateAirEnable Represents if circulation of air is enabled
+/// @param autoModeEnable Represents if auto mode is enabled
+/// @param defrostZone Represents the kind of defrost zone
+/// @param dualModeEnable Represents if dual mode is enabled
+/// @param acMaxEnable Represents if ac max is enabled
+/// @param ventilationMode Represents the kind of ventilation zone
+/// @param heatedSteeringWheelEnable Represents if heated steering wheel is enabled
+/// @param heatedWindshieldEnable Represents if heated windshield is enabled
+/// @param heatedRearWindowEnable Represents if heated rear window is enabled
+/// @param heatedMirrorsEnable Represents if heated mirrors are enabled
+/// @return An SDLClimateControlData object
- (instancetype)initWithFanSpeed:(nullable NSNumber<SDLInt> *)fanSpeed desiredTemperature:(nullable SDLTemperature *)desiredTemperature acEnable:(nullable NSNumber<SDLBool> *)acEnable circulateAirEnable:(nullable NSNumber<SDLBool> *)circulateAirEnable autoModeEnable:(nullable NSNumber<SDLBool> *)autoModeEnable defrostZone:(nullable SDLDefrostZone)defrostZone dualModeEnable:(nullable NSNumber<SDLBool> *)dualModeEnable acMaxEnable:(nullable NSNumber<SDLBool> *)acMaxEnable ventilationMode:(nullable SDLVentilationMode)ventilationMode heatedSteeringWheelEnable:(nullable NSNumber<SDLBool> *)heatedSteeringWheelEnable heatedWindshieldEnable:(nullable NSNumber<SDLBool> *)heatedWindshieldEnable heatedRearWindowEnable:(nullable NSNumber<SDLBool> *)heatedRearWindowEnable heatedMirrorsEnable:(nullable NSNumber<SDLBool> *)heatedMirrorsEnable __deprecated_msg("Use initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone: dualModeEnable:acMaxEnable:ventilationMode:heatedSteeringWheelEnable: heatedWindshieldEnable:heatedRearWindowEnable:heatedMirrorsEnable:climateEnable instead");
+/// Convenience init for climate control data with all properties.
+/// @param fanSpeed Speed of Fan in integer
+/// @param desiredTemperature Desired Temperature in SDLTemperature
+/// @param acEnable Represents if AC is enabled
+/// @param circulateAirEnable Represents if circulation of air is enabled
+/// @param autoModeEnable Represents if auto mode is enabled
+/// @param defrostZone Represents the kind of defrost zone
+/// @param dualModeEnable Represents if dual mode is enabled
+/// @param acMaxEnable Represents if ac max is enabled
+/// @param ventilationMode Represents the kind of ventilation zone
+/// @param heatedSteeringWheelEnable Represents if heated steering wheel is enabled
+/// @param heatedWindshieldEnable Represents if heated windshield is enabled
+/// @param heatedRearWindowEnable Represents if heated rear window is enabled
+/// @param heatedMirrorsEnable Represents if heated mirrors are enabled
+/// @param climateEnable Represents if climate is enabled
+/// @return An SDLClimateControlData object
- (instancetype)initWithFanSpeed:(nullable NSNumber<SDLInt> *)fanSpeed desiredTemperature:(nullable SDLTemperature *)desiredTemperature acEnable:(nullable NSNumber<SDLBool> *)acEnable circulateAirEnable:(nullable NSNumber<SDLBool> *)circulateAirEnable autoModeEnable:(nullable NSNumber<SDLBool> *)autoModeEnable defrostZone:(nullable SDLDefrostZone)defrostZone dualModeEnable:(nullable NSNumber<SDLBool> *)dualModeEnable acMaxEnable:(nullable NSNumber<SDLBool> *)acMaxEnable ventilationMode:(nullable SDLVentilationMode)ventilationMode heatedSteeringWheelEnable:(nullable NSNumber<SDLBool> *)heatedSteeringWheelEnable heatedWindshieldEnable:(nullable NSNumber<SDLBool> *)heatedWindshieldEnable heatedRearWindowEnable:(nullable NSNumber<SDLBool> *)heatedRearWindowEnable heatedMirrorsEnable:(nullable NSNumber<SDLBool> *)heatedMirrorsEnable climateEnable:(nullable NSNumber<SDLBool> *)climateEnable;
/**
@@ -67,7 +109,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *autoModeEnable;
/**
- * Represents the kind of defrost zone
+ * Represents the kind of defrost zone.
*
* Optional, SDLDefrostZone
*/
@@ -88,7 +130,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *acMaxEnable;
/**
- * Represents the kind of Ventilation zone
+ * Represents the kind of Ventilation zone.
*
* Optional, SDLVentilationMode
*/
diff --git a/SmartDeviceLink/SDLCloudAppProperties.h b/SmartDeviceLink/SDLCloudAppProperties.h
index 2bd33d94d..6f64956a8 100644
--- a/SmartDeviceLink/SDLCloudAppProperties.h
+++ b/SmartDeviceLink/SDLCloudAppProperties.h
@@ -13,7 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
* The cloud application properties.
*/
@interface SDLCloudAppProperties : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLConfiguration.h b/SmartDeviceLink/SDLConfiguration.h
index fcb871870..d5bfbb1c4 100644
--- a/SmartDeviceLink/SDLConfiguration.h
+++ b/SmartDeviceLink/SDLConfiguration.h
@@ -17,7 +17,8 @@
NS_ASSUME_NONNULL_BEGIN
-@interface SDLConfiguration : NSObject <NSCopying>
+/// Contains information about the apps configurtion, such as lifecycle, lockscreen, encryption, etc.
+@interface SDLCoSDLCreateInteractionChoiceSet.hnfiguration : NSObject <NSCopying>
/**
* The lifecycle configuration.
diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
index 1e094468d..8d05a1c79 100644
--- a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
+++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
@@ -23,6 +23,10 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLCreateInteractionChoiceSet : SDLRPCRequest
+/// Convenience init for creating a choice set
+/// @param choiceId A unique ID that identifies the Choice Set
+/// @param choiceSet Array of choices, which the user can select by menu or voice recognition
+/// @return An SDLCreateInteractionChoiceSet object
- (instancetype)initWithId:(UInt32)choiceId choiceSet:(NSArray<SDLChoice *> *)choiceSet;
/**
diff --git a/SmartDeviceLink/SDLCreateWindowResponse.h b/SmartDeviceLink/SDLCreateWindowResponse.h
index bc6dc6641..62684e165 100644
--- a/SmartDeviceLink/SDLCreateWindowResponse.h
+++ b/SmartDeviceLink/SDLCreateWindowResponse.h
@@ -6,6 +6,9 @@
NS_ASSUME_NONNULL_BEGIN
+/// Response to SDLCreateWindow
+///
+/// @since RPC 6.0
@interface SDLCreateWindowResponse : SDLRPCResponse
@end
diff --git a/SmartDeviceLink/SDLDateTime.h b/SmartDeviceLink/SDLDateTime.h
index a7c6e3696..33e3c6d28 100644
--- a/SmartDeviceLink/SDLDateTime.h
+++ b/SmartDeviceLink/SDLDateTime.h
@@ -10,12 +10,46 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLDateTime : SDLRPCStruct
+/// Convenience init for creating a date.
+///
+/// @param hour Hour part of time
+/// @param minute Minutes part of time
+/// @return An SDLDateTime object
- (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute;
+/// Convenience init for creating a date.
+///
+/// @param hour Hour part of time
+/// @param minute Minutes part of time
+/// @param second Seconds part of time
+/// @param millisecond Milliseconds part of time
+/// @return An SDLDateTime object
- (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute second:(UInt8)second millisecond:(UInt16)millisecond;
+/// Convenience init for creating a date.
+///
+/// @param hour Hour part of time
+/// @param minute Minutes part of time
+/// @param second Seconds part of time
+/// @param millisecond Milliseconds part of time
+/// @param day Day of the month
+/// @param month Month of the year
+/// @param year The year in YYYY format
+/// @return An SDLDateTime object
- (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute second:(UInt8)second millisecond:(UInt16)millisecond day:(UInt8)day month:(UInt8)month year:(UInt16)year;
+/// Convenience init for creating a date with all properties.
+///
+/// @param hour Hour part of time
+/// @param minute Minutes part of time
+/// @param second Seconds part of time
+/// @param millisecond Milliseconds part of time
+/// @param day Day of the month
+/// @param month Month of the year
+/// @param year The year in YYYY format
+/// @param timezoneMinuteOffset Time zone offset in Min with regard to UTC
+/// @param timezoneHourOffset Time zone offset in Hours with regard to UTC
+/// @return An SDLDateTime object
- (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute second:(UInt8)second millisecond:(UInt16)millisecond day:(UInt8)day month:(UInt8)month year:(UInt16)year timezoneMinuteOffset:(UInt8)timezoneMinuteOffset timezoneHourOffset:(int)timezoneHourOffset;
/**
diff --git a/SmartDeviceLink/SDLDeleteCommand.h b/SmartDeviceLink/SDLDeleteCommand.h
index 3d7e45801..5e065c0ca 100644
--- a/SmartDeviceLink/SDLDeleteCommand.h
+++ b/SmartDeviceLink/SDLDeleteCommand.h
@@ -21,6 +21,10 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLDeleteCommand : SDLRPCRequest
+/// Convenience init to remove a command from the menu.
+///
+/// @param commandId The Command ID that identifies the Command to be deleted from Command Menu
+/// @return An SDLDeleteCommand object
- (instancetype)initWithId:(UInt32)commandId;
/**