summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Fischer <joeljfischer@gmail.com>2021-07-14 08:53:38 -0400
committerGitHub <noreply@github.com>2021-07-14 08:53:38 -0400
commit8efb1824d61584eaa292990eaf0f72efdde411ee (patch)
treecc8d8da194af2563e1afd559925994ca4a9a2493
parent18eb8a84e45729afaf0976d738d292a60abc034a (diff)
parent5ad59966786aed393bffb22051da79b8146c0f5f (diff)
downloadsdl_ios-8efb1824d61584eaa292990eaf0f72efdde411ee.tar.gz
Merge pull request #2022 from smartdevicelink/Grammatical-and-Spelling-Updates-
Update spelling/ Grammar errors
-rw-r--r--SmartDeviceLink/public/SDLCreateWindow.h2
-rw-r--r--SmartDeviceLink/public/SDLFileManager.h4
-rw-r--r--SmartDeviceLink/public/SDLScreenManager.h2
-rw-r--r--SmartDeviceLink/public/SDLStreamingMediaConfiguration.h2
-rw-r--r--docs/Classes/SDLCreateWindow.html2
-rw-r--r--docs/Classes/SDLFileManager.html4
-rw-r--r--docs/Classes/SDLScreenManager.html2
-rw-r--r--docs/Classes/SDLStreamingMediaConfiguration.html2
8 files changed, 10 insertions, 10 deletions
diff --git a/SmartDeviceLink/public/SDLCreateWindow.h b/SmartDeviceLink/public/SDLCreateWindow.h
index ad4475ef2..7d54bab83 100644
--- a/SmartDeviceLink/public/SDLCreateWindow.h
+++ b/SmartDeviceLink/public/SDLCreateWindow.h
@@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(NSUInteger)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType;
/**
- Convinience constructor with all the parameters.
+ Convenience constructor with all the parameters.
@param windowId The type of the window to be created. Main window or widget.
@param windowName The window name to be used by the HMI. @see windowName
diff --git a/SmartDeviceLink/public/SDLFileManager.h b/SmartDeviceLink/public/SDLFileManager.h
index 4d0ce1ed5..b3edabacf 100644
--- a/SmartDeviceLink/public/SDLFileManager.h
+++ b/SmartDeviceLink/public/SDLFileManager.h
@@ -102,7 +102,7 @@ typedef void (^SDLFileManagerStartupCompletionHandler)(BOOL success, NSError *__
- (void)deleteRemoteFileWithName:(SDLFileName *)name completionHandler:(nullable SDLFileManagerDeleteCompletionHandler)completion NS_SWIFT_NAME(delete(fileName:completionHandler:));
/**
- * Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next the next delete request is sent.
+ * Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next delete request is sent.
*
* @param names The names of the files to be deleted
* @param completionHandler an optional SDLFileManagerMultiDeleteCompletionHandler
@@ -120,7 +120,7 @@ typedef void (^SDLFileManagerStartupCompletionHandler)(BOOL success, NSError *__
/**
* Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.
*
- * The optional progress handler can be used to keep track of the upload progress. After each file upload, the progress handler returns the upload percentage and an error, if one occured during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.
+ * The optional progress handler can be used to keep track of the upload progress. After each file upload, the progress handler returns the upload percentage and an error, if one occurred during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.
*
* @param files An array of SDLFiles to be sent
* @param progressHandler an optional SDLFileManagerMultiUploadProgressHandler
diff --git a/SmartDeviceLink/public/SDLScreenManager.h b/SmartDeviceLink/public/SDLScreenManager.h
index c941eaced..cb707bbd8 100644
--- a/SmartDeviceLink/public/SDLScreenManager.h
+++ b/SmartDeviceLink/public/SDLScreenManager.h
@@ -431,7 +431,7 @@ If set to `SDLDynamicMenuUpdatesModeForceOff`, menu updates will work the legacy
///
/// If the alert contains an audio indication with a file that needs to be uploaded, it will be uploaded before presenting the alert. If the alert contains soft buttons with images, they will be uploaded before presenting the alert. If the alert contains an icon, that will be uploaded before presenting the alert.
///
-/// The handler will be called when the alert either dismisses from the screen or it has failed to present. If the error value in the handler is present, then the alert failed to appear or was aborted, if not, then the alert dismissed without error. The `userInfo` object on the error contais an `error` key with more information about the error. If the alert failed to present, the `userInfo` object will contain a `tryAgainTime` key with information on how long to wait before trying to send another alert. The value for `tryAgainTime` may be `nil` if the module did not return a value in its response.
+/// The handler will be called when the alert either dismisses from the screen or it has failed to present. If the error value in the handler is present, then the alert failed to appear or was aborted, if not, then the alert dismissed without error. The `userInfo` object on the error contains an `error` key with more information about the error. If the alert failed to present, the `userInfo` object will contain a `tryAgainTime` key with information on how long to wait before trying to send another alert. The value for `tryAgainTime` may be `nil` if the module did not return a value in its response.
///
/// @param alert Alert to be presented
/// @param handler The handler to be called when the alert either dismisses from the screen or it has failed to present.
diff --git a/SmartDeviceLink/public/SDLStreamingMediaConfiguration.h b/SmartDeviceLink/public/SDLStreamingMediaConfiguration.h
index 669e59319..0f36df3df 100644
--- a/SmartDeviceLink/public/SDLStreamingMediaConfiguration.h
+++ b/SmartDeviceLink/public/SDLStreamingMediaConfiguration.h
@@ -84,7 +84,7 @@ typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) {
@property (assign, nonatomic) BOOL allowMultipleViewControllerOrientations;
/**
- Set a landscape image dimension range and/or aspect ratio range that your rootViewController supports. If the module's screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode or picture-in-picture), your rootViewController will be resized to the new screen size. If left unset or set to `nil`, the default is to support all lanscape streaming ranges. If you wish to disable support for streaming in landscape mode, set a `disabled` video streaming range.
+ Set a landscape image dimension range and/or aspect ratio range that your rootViewController supports. If the module's screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode or picture-in-picture), your rootViewController will be resized to the new screen size. If left unset or set to `nil`, the default is to support all landscape streaming ranges. If you wish to disable support for streaming in landscape mode, set a `disabled` video streaming range.
If desired, you can subscribe to screen size updates via the SDLStreamingVideoDelegate.
@warning If you disable both the supportedLandscapeStreamingRange and supportedPortraitStreamingRange, video will not stream
*/
diff --git a/docs/Classes/SDLCreateWindow.html b/docs/Classes/SDLCreateWindow.html
index 72a8b4982..91bef269f 100644
--- a/docs/Classes/SDLCreateWindow.html
+++ b/docs/Classes/SDLCreateWindow.html
@@ -54,7 +54,7 @@
-initWithId:windowName:windowType:associatedServiceType:duplicateUpdatesFromWindowID:
</h3>
- <p>Convinience constructor with all the parameters.</p>
+ <p>Convenience constructor with all the parameters.</p>
diff --git a/docs/Classes/SDLFileManager.html b/docs/Classes/SDLFileManager.html
index cd49b858c..a57cd48cd 100644
--- a/docs/Classes/SDLFileManager.html
+++ b/docs/Classes/SDLFileManager.html
@@ -269,7 +269,7 @@
-deleteRemoteFilesWithNames:completionHandler:
</h3>
- <p>Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next the next delete request is sent.</p>
+ <p>Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next delete request is sent.</p>
@@ -326,7 +326,7 @@
<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>
-<p>The optional progress handler can be used to keep track of the upload progress. After each file upload, the progress handler returns the upload percentage and an error, if one occured during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.</p>
+<p>The optional progress handler can be used to keep track of the upload progress. After each file upload, the progress handler returns the upload percentage and an error, if one occurred during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.</p>
diff --git a/docs/Classes/SDLScreenManager.html b/docs/Classes/SDLScreenManager.html
index f5f5427fd..d53402fe5 100644
--- a/docs/Classes/SDLScreenManager.html
+++ b/docs/Classes/SDLScreenManager.html
@@ -1035,7 +1035,7 @@
<p>If the alert contains an audio indication with a file that needs to be uploaded, it will be uploaded before presenting the alert. If the alert contains soft buttons with images, they will be uploaded before presenting the alert. If the alert contains an icon, that will be uploaded before presenting the alert.</p>
-<p>The handler will be called when the alert either dismisses from the screen or it has failed to present. If the error value in the handler is present, then the alert failed to appear or was aborted, if not, then the alert dismissed without error. The <code>userInfo</code> object on the error contais an <code>error</code> key with more information about the error. If the alert failed to present, the <code>userInfo</code> object will contain a <code>tryAgainTime</code> key with information on how long to wait before trying to send another alert. The value for <code>tryAgainTime</code> may be <code>nil</code> if the module did not return a value in its response.</p>
+<p>The handler will be called when the alert either dismisses from the screen or it has failed to present. If the error value in the handler is present, then the alert failed to appear or was aborted, if not, then the alert dismissed without error. The <code>userInfo</code> object on the error contains an <code>error</code> key with more information about the error. If the alert failed to present, the <code>userInfo</code> object will contain a <code>tryAgainTime</code> key with information on how long to wait before trying to send another alert. The value for <code>tryAgainTime</code> may be <code>nil</code> if the module did not return a value in its response.</p>
diff --git a/docs/Classes/SDLStreamingMediaConfiguration.html b/docs/Classes/SDLStreamingMediaConfiguration.html
index bad8b638b..ab2674319 100644
--- a/docs/Classes/SDLStreamingMediaConfiguration.html
+++ b/docs/Classes/SDLStreamingMediaConfiguration.html
@@ -180,7 +180,7 @@
supportedLandscapeStreamingRange
</h3>
- <p>Set a landscape image dimension range and/or aspect ratio range that your rootViewController supports. If the module&rsquo;s screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode or picture-in-picture), your rootViewController will be resized to the new screen size. If left unset or set to <code>nil</code>, the default is to support all lanscape streaming ranges. If you wish to disable support for streaming in landscape mode, set a <code>disabled</code> video streaming range.
+ <p>Set a landscape image dimension range and/or aspect ratio range that your rootViewController supports. If the module&rsquo;s screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode or picture-in-picture), your rootViewController will be resized to the new screen size. If left unset or set to <code>nil</code>, the default is to support all landscape streaming ranges. If you wish to disable support for streaming in landscape mode, set a <code>disabled</code> video streaming range.
If desired, you can subscribe to screen size updates via the SDLStreamingVideoDelegate.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>