diff options
| author | Frank Elias <francois.elias@livio.io> | 2020-09-18 08:59:11 -0400 |
|---|---|---|
| committer | Frank Elias <francois.elias@livio.io> | 2020-09-18 08:59:11 -0400 |
| commit | 4ce3d62ec29dc96dec3dcd8adb3977fe0e1ac49f (patch) | |
| tree | 45043ab2efaeac8a68d447b24a84b28347109357 | |
| parent | 9a16ac2e307929b920861940abb1f18a2df5ce07 (diff) | |
| download | sdl_ios-4ce3d62ec29dc96dec3dcd8adb3977fe0e1ac49f.tar.gz | |
Comment fix
init parameter description
| -rw-r--r-- | SmartDeviceLink/public/SDLSetGlobalProperties.h | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/SmartDeviceLink/public/SDLSetGlobalProperties.h b/SmartDeviceLink/public/SDLSetGlobalProperties.h index bb2adaa9d..58e333361 100644 --- a/SmartDeviceLink/public/SDLSetGlobalProperties.h +++ b/SmartDeviceLink/public/SDLSetGlobalProperties.h @@ -72,19 +72,19 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp menuTitle:(nullable NSString *)menuTitle menuIcon:(nullable SDLImage *)menuIcon keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties menuLayout:(nullable SDLMenuLayout)menuLayout __deprecated_msg("Use initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:userLocation:menuLayout: instead"); /** - Initialize SetGlobalProperties with all possible items - - @param helpPrompt A string that will be turned into TTS chunks for the help prompt - @param timeoutPrompt A string that will be turned into TTS chunks for the timeout prompt - @param vrHelpTitle The title of the help interface prompt - @param vrHelp The items of the help interface prompt - @param menuTitle The title of the menu button - @param menuIcon The icon on the menu button - @param keyboardProperties The properties of a keyboard prompt - @param userLocation userLocation - @param menuLayout The layout of the top-level main menu - @return The SetGlobalProperties RPC - */ +* Convenience init for setting all possible global properties +* +* @param userLocation - userLocation +* @param helpPrompt - helpPrompt +* @param timeoutPrompt - timeoutPrompt +* @param vrHelpTitle - vrHelpTitle +* @param vrHelp - vrHelp +* @param menuTitle - menuTitle +* @param menuIcon - menuIcon +* @param keyboardProperties - keyboardProperties +* @param menuLayout - menuLayout +* @return A SDLSetGlobalProperties object +*/ - (instancetype)initWithUserLocation:(nullable SDLSeatLocation *)userLocation helpPrompt:(nullable NSArray<SDLTTSChunk *> *)helpPrompt timeoutPrompt:(nullable NSArray<SDLTTSChunk *> *)timeoutPrompt vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp menuTitle:(nullable NSString *)menuTitle menuIcon:(nullable SDLImage *)menuIcon keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties menuLayout:(nullable SDLMenuLayout)menuLayout; |