Add some documentation to SystemRequest RPCfeature/issue_323_fix_systemrequest_unavailable

2 files changed, 12 insertions, 2 deletions

diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m
index f451e1069..3b127d76f 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m
@@ -287,7 +287,7 @@ const int POLICIES_CORRELATION_ID = 65535;
     }
 
     if ([functionName isEqualToString:@"OnSystemRequest"]) {
-        [self handleSystemRequest:dict];
+        [self handleOnSystemRequest:dict];
     }
 
     if ([functionName isEqualToString:@"SystemRequestResponse"]) {
@@ -349,7 +349,7 @@ const int POLICIES_CORRELATION_ID = 65535;
     }
 }
 
-- (void)handleSystemRequest:(NSDictionary *)dict {
+- (void)handleOnSystemRequest:(NSDictionary *)dict {
     [SDLDebugTool logInfo:@"OnSystemRequest (notification)" withType:SDLDebugType_RPC toOutput:SDLDebugOutput_All toGroup:self.debugConsoleGroupName];
 
     SDLOnSystemRequest *systemRequest = [[SDLOnSystemRequest alloc] initWithDictionary:[dict mutableCopy]];
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h
index 479b5d18e..8894012df 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h
@@ -17,7 +17,17 @@
 - (instancetype)init;
 - (instancetype)initWithDictionary:(NSMutableDictionary *)dict;
 
+/**
+ * The type of system request.
+ * Note that Proprietary requests should forward the binary data to the known proprietary module on the system.
+ */
 @property (strong) SDLRequestType *requestType;
+
+/**
+ * Filename of HTTP data to store in predefined system staging area.
+ * Mandatory if requestType is HTTP.
+ * PROPRIETARY requestType should ignore this parameter.
+ */
 @property (strong) NSString *fileName;
 
 @end