summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicoleYarroch <nicole@livio.io>2019-03-13 15:45:08 -0400
committerNicoleYarroch <nicole@livio.io>2019-03-13 15:45:08 -0400
commit1602b4e60fa4ccd9bb7ea18a80ae29ec6ddf2bf5 (patch)
tree220a9ae0d6b37fe7b1bd5bc139b744f71f9a057f
parent9cc2c49fd044341897693b27e2acfe70c30d8952 (diff)
downloadsdl_ios-bugfix/issue_1186_update_app_services_documentation.tar.gz
Updated library documentation per the rpc_specbugfix/issue_1186_update_app_services_documentation
Updated documentation per the rpc_spec for App Services
-rw-r--r--SmartDeviceLink/SDLAppServiceData.h2
-rw-r--r--SmartDeviceLink/SDLGetAppServiceDataResponse.h2
-rw-r--r--SmartDeviceLink/SDLGetFile.h2
-rw-r--r--SmartDeviceLink/SDLGetFileResponse.h4
-rw-r--r--SmartDeviceLink/SDLNavigationInstruction.h2
-rw-r--r--SmartDeviceLink/SDLPerformAppServiceInteraction.h2
-rw-r--r--SmartDeviceLink/SDLPerformAppServiceInteractionResponse.h4
7 files changed, 9 insertions, 9 deletions
diff --git a/SmartDeviceLink/SDLAppServiceData.h b/SmartDeviceLink/SDLAppServiceData.h
index af2ec4ded..ff6d487f5 100644
--- a/SmartDeviceLink/SDLAppServiceData.h
+++ b/SmartDeviceLink/SDLAppServiceData.h
@@ -18,7 +18,7 @@
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. (eg if service type equals MEDIA, the mediaServiceData param should be included.
+ * 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).
*/
@interface SDLAppServiceData : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLGetAppServiceDataResponse.h b/SmartDeviceLink/SDLGetAppServiceDataResponse.h
index cd05e4710..fea47f4d0 100644
--- a/SmartDeviceLink/SDLGetAppServiceDataResponse.h
+++ b/SmartDeviceLink/SDLGetAppServiceDataResponse.h
@@ -13,7 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
/*
- * This response includes the data that is requested from the specific service.
+ * This response includes the data that was requested from the specific service.
*/
@interface SDLGetAppServiceDataResponse : SDLRPCResponse
diff --git a/SmartDeviceLink/SDLGetFile.h b/SmartDeviceLink/SDLGetFile.h
index 3a63ab737..bdc7936d9 100644
--- a/SmartDeviceLink/SDLGetFile.h
+++ b/SmartDeviceLink/SDLGetFile.h
@@ -75,7 +75,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber<SDLUInt> *offset;
/**
- * Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded.
+ * Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded.
*
* Integer, Optional, minvalue="0" maxvalue="2000000000"
*/
diff --git a/SmartDeviceLink/SDLGetFileResponse.h b/SmartDeviceLink/SDLGetFileResponse.h
index 96164d3bf..cf6a5cef9 100644
--- a/SmartDeviceLink/SDLGetFileResponse.h
+++ b/SmartDeviceLink/SDLGetFileResponse.h
@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
* Convenience init for all parameters.
*
* @param offset Optional offset in bytes for resuming partial data chunks
- * @param length Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded
+ * @param length Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded
* @param fileType File type that is being sent in response
* @param crc Additional CRC32 checksum to protect data integrity up to 512 Mbits
* @return A SDLGetFileResponse object
@@ -34,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber<SDLUInt> *offset;
/**
- * Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded.
+ * Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded.
*
* Integer, Optional, minvalue="0" maxvalue="2000000000"
*/
diff --git a/SmartDeviceLink/SDLNavigationInstruction.h b/SmartDeviceLink/SDLNavigationInstruction.h
index ee9241895..88b347fc5 100644
--- a/SmartDeviceLink/SDLNavigationInstruction.h
+++ b/SmartDeviceLink/SDLNavigationInstruction.h
@@ -84,7 +84,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) SDLNavigationJunction junctionType;
/**
- * Used to infer which side of the road this instruction takes place. For a U-Turn (Action=Turn, direction=180) this will determine which direction the turn should take place.
+ * Used to infer which side of the road this instruction takes place. For a U-Turn (action=TURN, bearing=180) this will determine which direction the turn should take place.
*
* SDLDirection, Optional
*/
diff --git a/SmartDeviceLink/SDLPerformAppServiceInteraction.h b/SmartDeviceLink/SDLPerformAppServiceInteraction.h
index 6d69c8323..f85c66387 100644
--- a/SmartDeviceLink/SDLPerformAppServiceInteraction.h
+++ b/SmartDeviceLink/SDLPerformAppServiceInteraction.h
@@ -47,7 +47,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithServiceUri:(NSString *)serviceUri serviceID:(NSString *)serviceID originApp:(NSString *)originApp requestServiceActive:(BOOL)requestServiceActive;
/**
- * Fully qualified URI based on the URI prefix and URI scheme the app service provided. SDL makes no gurantee that this URI is correct.
+ * Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this URI is correct.
*
* String, Required
*/
diff --git a/SmartDeviceLink/SDLPerformAppServiceInteractionResponse.h b/SmartDeviceLink/SDLPerformAppServiceInteractionResponse.h
index 8fbadebf2..7d5d6cc13 100644
--- a/SmartDeviceLink/SDLPerformAppServiceInteractionResponse.h
+++ b/SmartDeviceLink/SDLPerformAppServiceInteractionResponse.h
@@ -19,13 +19,13 @@ NS_ASSUME_NONNULL_BEGIN
/**
* Convenience init for all parameters.
*
- * @param serviceSpecificResult The service can provide specific result strings to the consumer through this param. These results should be described in the URI schema set in the Service Manifest
+ * @param serviceSpecificResult The service can provide specific result strings to the consumer through this param.
* @return A SDLPerformAppServiceInteractionResponse object
*/
- (instancetype)initWithServiceSpecificResult:(NSString *)serviceSpecificResult;
/**
- * The service can provide specific result strings to the consumer through this param. These results should be described in the URI schema set in the Service Manifest.
+ * The service can provide specific result strings to the consumer through this param.
*
* String, Optional
*/