diff options
author | Justin Gluck <justin.gluck@livio.io> | 2019-11-04 09:34:57 -0500 |
---|---|---|
committer | Justin Gluck <justin.gluck@livio.io> | 2019-11-04 09:34:57 -0500 |
commit | 0e73ef395db0174c977a186429a4f61c0db1bccd (patch) | |
tree | 15b9d21f39031a082b323e9377af838b1f4b96a8 | |
parent | 07fa2de016c15749bea55af48ee7fb3f4ffddf2c (diff) | |
download | sdl_ios-0e73ef395db0174c977a186429a4f61c0db1bccd.tar.gz |
small isues
-rw-r--r-- | SmartDeviceLink/SDLAlertManeuver.h | 5 | ||||
-rw-r--r-- | SmartDeviceLink/SDLArtwork.h | 4 | ||||
-rw-r--r-- | SmartDeviceLink/SDLAudioControlCapabilities.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLChoiceSetDelegate.h | 6 | ||||
-rw-r--r-- | SmartDeviceLink/SDLCreateInteractionChoiceSet.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLDateTime.h | 8 | ||||
-rw-r--r-- | SmartDeviceLink/SDLDeleteCommand.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLDeleteInteractionChoiceSet.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLDeleteSubMenu.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLDiagnosticMessage.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLDialNumber.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLEqualizerSettings.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLGetDTCs.h | 4 | ||||
-rw-r--r-- | SmartDeviceLink/SDLLightControlCapabilities.h | 2 |
14 files changed, 23 insertions, 22 deletions
diff --git a/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink/SDLAlertManeuver.h index f3625ff8a..2e67467fc 100644 --- a/SmartDeviceLink/SDLAlertManeuver.h +++ b/SmartDeviceLink/SDLAlertManeuver.h @@ -18,14 +18,15 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLAlertManeuver : SDLRPCRequest -/// Create a new alert maneuver with these parameters +/// Convenience init to create an alert maneuver with these parameters /// /// @param ttsText The text to speak /// @param softButtons An arry of soft buttons +/// /// @return An SDLAlertManeuver object - (instancetype)initWithTTS:(nullable NSString *)ttsText softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons; -/// Create a new alert maneuver with these parameters +/// Convenience init to create an alert maneuver with all parameters /// /// @param ttsChunks An array of text chunks /// @param softButtons An arry of soft buttons diff --git a/SmartDeviceLink/SDLArtwork.h b/SmartDeviceLink/SDLArtwork.h index 43078894c..587bc1c8c 100644 --- a/SmartDeviceLink/SDLArtwork.h +++ b/SmartDeviceLink/SDLArtwork.h @@ -16,10 +16,10 @@ /// Format of the Artwork typedef NS_ENUM(NSUInteger, SDLArtworkImageFormat) { - /// Image foramt: PNG + /// Image format: PNG SDLArtworkImageFormatPNG, - /// Image foramt: JPG + /// Image format: JPG SDLArtworkImageFormatJPG }; diff --git a/SmartDeviceLink/SDLAudioControlCapabilities.h b/SmartDeviceLink/SDLAudioControlCapabilities.h index 119bce447..d8d381412 100644 --- a/SmartDeviceLink/SDLAudioControlCapabilities.h +++ b/SmartDeviceLink/SDLAudioControlCapabilities.h @@ -7,7 +7,7 @@ NS_ASSUME_NONNULL_BEGIN /** - Current audio control capabilitie. If included, the platform supports audio controls + Current audio control capability. If included, the platform supports audio controls. @since RPC 5.0 */ diff --git a/SmartDeviceLink/SDLChoiceSetDelegate.h b/SmartDeviceLink/SDLChoiceSetDelegate.h index 7ff4b0b40..de7573e95 100644 --- a/SmartDeviceLink/SDLChoiceSetDelegate.h +++ b/SmartDeviceLink/SDLChoiceSetDelegate.h @@ -15,10 +15,10 @@ NS_ASSUME_NONNULL_BEGIN -/// Delegate for the the SDLChoiceSet. +/// Delegate for the the SDLChoiceSet. Contains methods that get called when an action is taken on a choice cell. @protocol SDLChoiceSetDelegate <NSObject> -/// Delegate method called after a choice set item was selected +/// Delegate method called after a choice set item is selected /// /// @param choiceSet The choice set displayed /// @param choice The item selected @@ -28,7 +28,7 @@ NS_ASSUME_NONNULL_BEGIN /// Delegate method called on an error /// -/// @param choiceSet TSDLAudioStreamManager.hhe choice set displayed +/// @param choiceSet The choice set /// @param error The error - (void)choiceSet:(SDLChoiceSet *)choiceSet didReceiveError:(NSError *)error; diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h index e7f612fa1..9abdf627e 100644 --- a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h +++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h @@ -24,7 +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 diff --git a/SmartDeviceLink/SDLDateTime.h b/SmartDeviceLink/SDLDateTime.h index 33e3c6d28..905012f44 100644 --- a/SmartDeviceLink/SDLDateTime.h +++ b/SmartDeviceLink/SDLDateTime.h @@ -10,14 +10,14 @@ NS_ASSUME_NONNULL_BEGIN */ @interface SDLDateTime : SDLRPCStruct -/// Convenience init for creating a date. +/// 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. +/// Convenience init for creating a date /// /// @param hour Hour part of time /// @param minute Minutes part of time @@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN /// @return An SDLDateTime object - (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute second:(UInt8)second millisecond:(UInt16)millisecond; -/// Convenience init for creating a date. +/// Convenience init for creating a date /// /// @param hour Hour part of time /// @param minute Minutes part of time @@ -38,7 +38,7 @@ NS_ASSUME_NONNULL_BEGIN /// @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. +/// Convenience init for creating a date with all properties /// /// @param hour Hour part of time /// @param minute Minutes part of time diff --git a/SmartDeviceLink/SDLDeleteCommand.h b/SmartDeviceLink/SDLDeleteCommand.h index 5e065c0ca..f6b059c20 100644 --- a/SmartDeviceLink/SDLDeleteCommand.h +++ b/SmartDeviceLink/SDLDeleteCommand.h @@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDeleteCommand : SDLRPCRequest -/// Convenience init to remove a command from the menu. +/// 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 diff --git a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h index 6c77ff1fb..19bbc069f 100644 --- a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h +++ b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h @@ -23,7 +23,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDeleteInteractionChoiceSet : SDLRPCRequest -/// Convenience init to delete a choice set. +/// Convenience init to delete a choice set /// /// @param choiceId A unique ID that identifies the Choice Set /// @return An SDLDeleteInteractionChoiceSet object diff --git a/SmartDeviceLink/SDLDeleteSubMenu.h b/SmartDeviceLink/SDLDeleteSubMenu.h index e0783453c..5f9bf73ff 100644 --- a/SmartDeviceLink/SDLDeleteSubMenu.h +++ b/SmartDeviceLink/SDLDeleteSubMenu.h @@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDeleteSubMenu : SDLRPCRequest -/// Convenience init to delete a submenu. +/// Convenience init to delete a submenu /// /// @param menuId Identifies the SDLSubMenu to be delete /// @return An SDLDeleteSubMenu object diff --git a/SmartDeviceLink/SDLDiagnosticMessage.h b/SmartDeviceLink/SDLDiagnosticMessage.h index c01ce4fa8..74cbbcdff 100644 --- a/SmartDeviceLink/SDLDiagnosticMessage.h +++ b/SmartDeviceLink/SDLDiagnosticMessage.h @@ -14,7 +14,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDiagnosticMessage : SDLRPCRequest -/// Convenience init. +/// Convenience init /// /// @param targetId Name of target ECU /// @param length Length of message (in bytes) diff --git a/SmartDeviceLink/SDLDialNumber.h b/SmartDeviceLink/SDLDialNumber.h index 838449e0c..44c6b7751 100644 --- a/SmartDeviceLink/SDLDialNumber.h +++ b/SmartDeviceLink/SDLDialNumber.h @@ -14,7 +14,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDialNumber : SDLRPCRequest -/// Convenience init to initiate a dial number request. +/// 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 diff --git a/SmartDeviceLink/SDLEqualizerSettings.h b/SmartDeviceLink/SDLEqualizerSettings.h index 0f25dc1b5..c42db47d2 100644 --- a/SmartDeviceLink/SDLEqualizerSettings.h +++ b/SmartDeviceLink/SDLEqualizerSettings.h @@ -11,7 +11,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLEqualizerSettings : SDLRPCStruct -/// Convenience init. +/// Convenience init /// /// @param channelId Read-only channel / frequency name /// @param channelSetting Reflects the setting, from 0%-100%. diff --git a/SmartDeviceLink/SDLGetDTCs.h b/SmartDeviceLink/SDLGetDTCs.h index 150b04d55..2ba8339d5 100644 --- a/SmartDeviceLink/SDLGetDTCs.h +++ b/SmartDeviceLink/SDLGetDTCs.h @@ -18,13 +18,13 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLGetDTCs : SDLRPCRequest -/// Convenience init. +/// Convenience init /// /// @param name Name of the module to receive the DTC form /// @return An SDLGetDTCs object - (instancetype)initWithECUName:(UInt16)name; -/// Convenience init with all properties. +/// Convenience init with all properties /// /// @param name Name of the module to receive the DTC form /// @param mask DTC Mask Byte to be sent in diagnostic request to module diff --git a/SmartDeviceLink/SDLLightControlCapabilities.h b/SmartDeviceLink/SDLLightControlCapabilities.h index 3466ca4dd..7f18ee769 100644 --- a/SmartDeviceLink/SDLLightControlCapabilities.h +++ b/SmartDeviceLink/SDLLightControlCapabilities.h @@ -9,7 +9,7 @@ NS_ASSUME_NONNULL_BEGIN -///Current light control capabilitie. If included, the platform supports light controls +/// Current light control capabilitie. If included, the platform supports light controls. /// /// @since RPC 5.0 @interface SDLLightControlCapabilities : SDLRPCStruct |