diff options
author | NicoleYarroch <nicole@livio.io> | 2018-05-24 08:48:43 -0400 |
---|---|---|
committer | NicoleYarroch <nicole@livio.io> | 2018-05-24 08:48:43 -0400 |
commit | 7b2d3efbf423be755cdfaeabb4c08b3c9a9875b4 (patch) | |
tree | 95a8c442f0a52e1664ef4c7481569e503e84dd54 | |
parent | a6b57d28b6834e23878a01f7ecaf8bbff9bb465a (diff) | |
download | sdl_ios-7b2d3efbf423be755cdfaeabb4c08b3c9a9875b4.tar.gz |
Added documentation to SDLRPCStruct
Signed-off-by: NicoleYarroch <nicole@livio.io>
-rw-r--r-- | SmartDeviceLink/SDLRPCStruct.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLRPCStruct.h b/SmartDeviceLink/SDLRPCStruct.h index 224dfd30e..2b05e745c 100644 --- a/SmartDeviceLink/SDLRPCStruct.h +++ b/SmartDeviceLink/SDLRPCStruct.h @@ -12,9 +12,27 @@ NS_ASSUME_NONNULL_BEGIN NSMutableDictionary<NSString *, id> *store; } +/** + * Convenience init + * + * @param dict A dictionary + * @return A SDLRPCStruct object + */ - (instancetype)initWithDictionary:(NSDictionary<NSString *, id> *)dict; + +/** + * Init + * + * @return A SDLRPCStruct object + */ - (instancetype)init; +/** + * Converts struct to JSON formatted data + * + * @param version The protocol version + * @return JSON formatted data + */ - (NSDictionary<NSString *, id> *)serializeAsDictionary:(Byte)version; @end |