diff options
author | Justin Gluck <justin.gluck@livio.io> | 2019-11-01 13:34:48 -0400 |
---|---|---|
committer | Justin Gluck <justin.gluck@livio.io> | 2019-11-01 13:34:48 -0400 |
commit | 22f86b42824aacc48b9f936582078f79941e1edd (patch) | |
tree | 9c2485192bca30c56f92c564406c53eb7f7e1b33 | |
parent | 4863cb92607bbfa4eb51c99b6960077a5b954db5 (diff) | |
download | sdl_ios-22f86b42824aacc48b9f936582078f79941e1edd.tar.gz |
final few documenting lines
-rw-r--r-- | SmartDeviceLink/SDLEnum.h | 3 | ||||
-rw-r--r-- | SmartDeviceLink/SDLNotificationConstants.h | 4 | ||||
-rw-r--r-- | SmartDeviceLink/SDLRPCFunctionNames.h | 2 | ||||
-rw-r--r-- | SmartDeviceLink/SDLRPCStruct.h | 4 | ||||
-rw-r--r-- | SmartDeviceLink/SDLStreamingMediaManagerConstants.h | 4 | ||||
-rw-r--r-- | SmartDeviceLink/SDLTouchManagerDelegate.h | 1 | ||||
-rw-r--r-- | SmartDeviceLink/SDLVersion.h | 5 |
7 files changed, 19 insertions, 4 deletions
diff --git a/SmartDeviceLink/SDLEnum.h b/SmartDeviceLink/SDLEnum.h index de26aed86..a35c1fa4c 100644 --- a/SmartDeviceLink/SDLEnum.h +++ b/SmartDeviceLink/SDLEnum.h @@ -7,9 +7,10 @@ NS_ASSUME_NONNULL_BEGIN -/// Compares two enums for equivalents +/// NSString SDLEnum typedef typedef NSString* SDLEnum SDL_SWIFT_ENUM; +/// Compares two enums for equivalents @interface NSString (SDLEnum) /** diff --git a/SmartDeviceLink/SDLNotificationConstants.h b/SmartDeviceLink/SDLNotificationConstants.h index 3a5e2b0b8..b9b7faa8f 100644 --- a/SmartDeviceLink/SDLNotificationConstants.h +++ b/SmartDeviceLink/SDLNotificationConstants.h @@ -25,8 +25,12 @@ NS_ASSUME_NONNULL_BEGIN #define NOTIFICATION_TYPEDEF NSNotificationName #endif +/// NSNotification names typedef NOTIFICATION_TYPEDEF SDLNotificationName; +/// SDLNotificationUserInfoKey +/// +/// The key used in all SDL NSNotifications to extract the response or notification from the userinfo dictionary. typedef NSString *SDLNotificationUserInfoKey; #pragma mark - Blocks diff --git a/SmartDeviceLink/SDLRPCFunctionNames.h b/SmartDeviceLink/SDLRPCFunctionNames.h index 47cb73a70..f2738e1b1 100644 --- a/SmartDeviceLink/SDLRPCFunctionNames.h +++ b/SmartDeviceLink/SDLRPCFunctionNames.h @@ -8,7 +8,7 @@ #import "SDLEnum.h" -/* +/** * All RPC request / response / notification names */ typedef SDLEnum SDLRPCFunctionName SDL_SWIFT_ENUM; diff --git a/SmartDeviceLink/SDLRPCStruct.h b/SmartDeviceLink/SDLRPCStruct.h index f6f5be5ab..1832f74c4 100644 --- a/SmartDeviceLink/SDLRPCStruct.h +++ b/SmartDeviceLink/SDLRPCStruct.h @@ -8,11 +8,15 @@ NS_ASSUME_NONNULL_BEGIN +/// Contains information about the store @interface SDLRPCStruct : NSObject <NSCopying> /// The store that contains RPC data @property (strong, nonatomic, readonly) NSMutableDictionary<NSString *, id> *store; + +/// BOOL representing if the payload is protected @property (assign, nonatomic, getter=isPayloadProtected) BOOL payloadProtected; + /** * Convenience init * diff --git a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h index d3aea45ca..291eb11a4 100644 --- a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h +++ b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h @@ -51,7 +51,9 @@ extern NSString *const SDLLockScreenManagerWillDismissLockScreenViewController; /// Lockscreen did dismiss notification extern NSString *const SDLLockScreenManagerDidDismissLockScreenViewController; +/// The current state of the video stream manager typedef NSString SDLVideoStreamManagerState; + /// Streaming state stopped extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateStopped; @@ -67,7 +69,9 @@ extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateSuspended; /// Streaming state shutting down extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateShuttingDown; +/// The current state of the audio stream manager typedef NSString SDLAudioStreamManagerState; + /// Audio state stopped extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateStopped; diff --git a/SmartDeviceLink/SDLTouchManagerDelegate.h b/SmartDeviceLink/SDLTouchManagerDelegate.h index 29f53bc02..1e3bc57b5 100644 --- a/SmartDeviceLink/SDLTouchManagerDelegate.h +++ b/SmartDeviceLink/SDLTouchManagerDelegate.h @@ -12,6 +12,7 @@ NS_ASSUME_NONNULL_BEGIN +/// The delegate to be notified of processed touches such as pinches, pans, and taps @protocol SDLTouchManagerDelegate <NSObject> @optional diff --git a/SmartDeviceLink/SDLVersion.h b/SmartDeviceLink/SDLVersion.h index 13e88dd03..9b262b208 100644 --- a/SmartDeviceLink/SDLVersion.h +++ b/SmartDeviceLink/SDLVersion.h @@ -74,15 +74,16 @@ NS_ASSUME_NONNULL_BEGIN /// Convenience init to set version using SDLMsgVersion /// /// @param sdlMsgVersion Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application. -/// @return +/// @return An SDLVersion object - (instancetype)initWithSDLMsgVersion:(SDLMsgVersion *)sdlMsgVersion; /// Convenience init to set version using SDLMsgVersion /// /// @param sdlMsgVersion Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application. -/// @return +/// @return SDLVersion object + (instancetype)versionWithSDLMsgVersion:(SDLMsgVersion *)sdlMsgVersion; +/// Compare two SDLVersions - (NSComparisonResult)compare:(SDLVersion *)otherVersion; /// Compare is less than |