documentation

7 files changed, 76 insertions, 1 deletions

diff --git a/SmartDeviceLink/NSNumber+NumberType.h b/SmartDeviceLink/NSNumber+NumberType.h
index 56a584fc0..669ae2e41 100644
--- a/SmartDeviceLink/NSNumber+NumberType.h
+++ b/SmartDeviceLink/NSNumber+NumberType.h
@@ -32,6 +32,7 @@
 @protocol SDLFloat
 @end
 
+/// Declarations
 @interface NSNumber (NumberType) <SDLInt, SDLUInt, SDLBool, SDLFloat>
 
 @end
diff --git a/SmartDeviceLink/SDLServiceEncryptionDelegate.h b/SmartDeviceLink/SDLServiceEncryptionDelegate.h
index f87a41cc6..dd45696a9 100644
--- a/SmartDeviceLink/SDLServiceEncryptionDelegate.h
+++ b/SmartDeviceLink/SDLServiceEncryptionDelegate.h
@@ -12,6 +12,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Delegate for the encryption service.
 @protocol SDLServiceEncryptionDelegate <NSObject>
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingMediaConfiguration.h b/SmartDeviceLink/SDLStreamingMediaConfiguration.h
index abe5ea799..9c73cda8f 100644
--- a/SmartDeviceLink/SDLStreamingMediaConfiguration.h
+++ b/SmartDeviceLink/SDLStreamingMediaConfiguration.h
@@ -30,6 +30,7 @@ typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) {
     SDLCarWindowRenderingTypeViewBeforeScreenUpdates
 };
 
+/// The streaming media configuration. Use this class to configure streaming media information.
 @interface SDLStreamingMediaConfiguration : NSObject <NSCopying>
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
index ef3d44881..d3aea45ca 100644
--- a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
+++ b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
@@ -80,7 +80,9 @@ extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateReady;
 /// Audio state shutting down
 extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateShuttingDown;
 
+/// Typedef SDLAppState
 typedef NSString SDLAppState;
+
 /// App state inactive
 extern SDLAppState *const SDLAppStateInactive;
 
diff --git a/SmartDeviceLink/SDLTouch.h b/SmartDeviceLink/SDLTouch.h
index a0234a5d8..fe114be17 100644
--- a/SmartDeviceLink/SDLTouch.h
+++ b/SmartDeviceLink/SDLTouch.h
@@ -23,6 +23,7 @@ typedef enum {
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Describes a touch location
 @interface SDLTouch : NSObject
 
 /**
diff --git a/SmartDeviceLink/SDLTouchManager.h b/SmartDeviceLink/SDLTouchManager.h
index cd7e01cf4..4b9926fd3 100644
--- a/SmartDeviceLink/SDLTouchManager.h
+++ b/SmartDeviceLink/SDLTouchManager.h
@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 typedef void(^SDLTouchEventHandler)(SDLTouch *touch, SDLTouchType type);
 
-
+/// Touch Manager responsible for providing touch event notifications.
 @interface SDLTouchManager : NSObject
 
 /**
diff --git a/SmartDeviceLink/SDLVersion.h b/SmartDeviceLink/SDLVersion.h
index aafa3efee..13e88dd03 100644
--- a/SmartDeviceLink/SDLVersion.h
+++ b/SmartDeviceLink/SDLVersion.h
@@ -13,6 +13,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application.
 @interface SDLVersion : NSObject <NSCopying>
 
 /// Major version
@@ -27,23 +28,91 @@ NS_ASSUME_NONNULL_BEGIN
 /// A String format of the current SDLVersion
 @property (nonatomic, copy, readonly) NSString *stringVersion;
 
+/// Convenience init
+///
+/// @param major Major version
+/// @param minor Minor version
+/// @param patch Patch version
+/// @return An SDLVersion object
 - (instancetype)initWithMajor:(NSUInteger)major minor:(NSUInteger)minor patch:(NSUInteger)patch;
+
+/// Convenience init
+///
+/// @param major Major version
+/// @param minor Minor version
+/// @param patch Patch version
+/// @return An SDLVersion object
 + (instancetype)versionWithMajor:(NSUInteger)major minor:(NSUInteger)minor patch:(NSUInteger)patch;
+
+/// Convenience init
+///
+/// @param versionString String representation of the version
+/// @return An SDLVersion object
 - (nullable instancetype)initWithString:(NSString *)versionString;
+
+/// Convenience init
+///
+/// @param versionString String representation of the version
+/// @return An SDLVersion object
 + (nullable instancetype)versionWithString:(NSString *)versionString;
+
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-implementations"
+/// Deprecated convenience init to set version using SDLSyncMsgVersion
+///
+/// @param syncMsgVersion Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application.
+/// @return An SDLVersion object
 - (instancetype)initWithSyncMsgVersion:(SDLSyncMsgVersion *)syncMsgVersion __deprecated_msg(("Use initWithSDLMsgVersion:sdlMsgVersion: instead"));
+
+/// Deprecated convenience init to set version using SDLSyncMsgVersion
+///
+/// @param syncMsgVersion Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application.
+/// @return An SDLVersion object
 + (instancetype)versionWithSyncMsgVersion:(SDLSyncMsgVersion *)syncMsgVersion __deprecated_msg(("Use versionWithSDLMsgVersion:sdlMsgVersion instead"));
 #pragma clang diagnostic pop
+
+/// 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
 - (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
 + (instancetype)versionWithSDLMsgVersion:(SDLMsgVersion *)sdlMsgVersion;
 
 - (NSComparisonResult)compare:(SDLVersion *)otherVersion;
+
+/// Compare is less than
+///
+/// @param otherVersion SDLVersion Object
+/// @return BOOL
 - (BOOL)isLessThanVersion:(SDLVersion *)otherVersion;
+
+/// Compare is equal to
+///
+/// @param otherVersion SDLVersion Object
+/// @return BOOL
 - (BOOL)isEqualToVersion:(SDLVersion *)otherVersion;
+
+/// Compare is greater than
+///
+/// @param otherVersion SDLVersion Object
+/// @return BOOL
 - (BOOL)isGreaterThanVersion:(SDLVersion *)otherVersion;
+
+/// Compare is greater than or equal to
+///
+/// @param otherVersion SDLVersion Object
+/// @return BOOL
 - (BOOL)isGreaterThanOrEqualToVersion:(SDLVersion *)otherVersion;
+
+/// Compare is less than or equal to
+///
+/// @param otherVersion SDLVersion Object
+/// @return BOOL
 - (BOOL)isLessThanOrEqualToVersion:(SDLVersion *)otherVersion;
 
 @end