summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Gluck <justin.gluck@livio.io>2019-11-01 14:54:50 -0400
committerJustin Gluck <justin.gluck@livio.io>2019-11-01 14:54:50 -0400
commit07fa2de016c15749bea55af48ee7fb3f4ffddf2c (patch)
treee32fa4c65d5e78b6d1dc3fb62979b62f20418f80
parent0a79d7ba061d1d6c8bbc769b44787be728328c32 (diff)
downloadsdl_ios-07fa2de016c15749bea55af48ee7fb3f4ffddf2c.tar.gz
minor fixes
-rw-r--r--SmartDeviceLink/SDLAddSubMenu.h11
-rw-r--r--SmartDeviceLink/SDLAlertManeuver.h5
-rw-r--r--SmartDeviceLink/SDLAlertResponse.h2
-rw-r--r--SmartDeviceLink/SDLAppInfo.h5
-rw-r--r--SmartDeviceLink/SDLCreateInteractionChoiceSet.h1
5 files changed, 14 insertions, 10 deletions
diff --git a/SmartDeviceLink/SDLAddSubMenu.h b/SmartDeviceLink/SDLAddSubMenu.h
index 4a9dcc9a6..6f289e811 100644
--- a/SmartDeviceLink/SDLAddSubMenu.h
+++ b/SmartDeviceLink/SDLAddSubMenu.h
@@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAddSubMenu : SDLRPCRequest
-/// Convenience init to create a new add sub menu.
+/// Convenience init for creating an add submenu
///
/// @param menuId A menu id
/// @param menuName The menu name
-/// @return An instance of the add submenu class
+/// @return An SDLAddSubMenu object
- (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName;
-/// Convenience init to create a new add sub menu.
+/// Convenience init for creating an add submenu
///
/// @param menuId A menu id
/// @param menuName The menu name
@@ -41,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN
/// @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.
+/// Convenience init for creating an add submenu
///
/// @param menuId A menu id
/// @param menuName The menu name
@@ -50,7 +50,8 @@ NS_ASSUME_NONNULL_BEGIN
/// @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.
+/// Convenience init for creating an add submenu with all properties.
+///
/// @param menuId A menu id
/// @param menuName The menu name
/// @param menuLayout The sub-menu layout
diff --git a/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink/SDLAlertManeuver.h
index cf79561bd..f3625ff8a 100644
--- a/SmartDeviceLink/SDLAlertManeuver.h
+++ b/SmartDeviceLink/SDLAlertManeuver.h
@@ -22,13 +22,14 @@ NS_ASSUME_NONNULL_BEGIN
///
/// @param ttsText The text to speak
/// @param softButtons An arry of soft buttons
-/// @return An instance of the alert maneuver class
+/// @return An SDLAlertManeuver object
- (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
+/// @return An SDLAlertManeuver object
- (instancetype)initWithTTSChunks:(nullable NSArray<SDLTTSChunk *> *)ttsChunks softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
/**
diff --git a/SmartDeviceLink/SDLAlertResponse.h b/SmartDeviceLink/SDLAlertResponse.h
index 281a7341d..db73310a6 100644
--- a/SmartDeviceLink/SDLAlertResponse.h
+++ b/SmartDeviceLink/SDLAlertResponse.h
@@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
/// Amount of time (in seconds) that an app must wait before resending an alert.
///
-/// @since 2.0
+/// @since RPC 2.0
@property (nullable, strong, nonatomic) NSNumber<SDLInt> *tryAgainTime;
@end
diff --git a/SmartDeviceLink/SDLAppInfo.h b/SmartDeviceLink/SDLAppInfo.h
index 1caee38fa..2aaff168e 100644
--- a/SmartDeviceLink/SDLAppInfo.h
+++ b/SmartDeviceLink/SDLAppInfo.h
@@ -10,8 +10,9 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLAppInfo : SDLRPCStruct
-/// Create a new app info
-/// @return An instance of the app info class
+/// Convenience init with no parameters
+///
+/// @return An SDLAppInfo object
+ (instancetype)currentAppInfo;
/**
diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
index 8d05a1c79..e7f612fa1 100644
--- a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
+++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
@@ -24,6 +24,7 @@ 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