Added more documentation

* SDLEnum
* SDLIAPSessionDelegate
* SDLIAPTransport
* SDLTCPTransport

Signed-off-by: NicoleYarroch <nicole@livio.io>

4 files changed, 46 insertions, 0 deletions

diff --git a/SmartDeviceLink/SDLEnum.h b/SmartDeviceLink/SDLEnum.h
index f224d8ea3..f00de3929 100644
--- a/SmartDeviceLink/SDLEnum.h
+++ b/SmartDeviceLink/SDLEnum.h
@@ -11,6 +11,12 @@ typedef NSString* SDLEnum SDL_SWIFT_ENUM;
 
 @interface NSString (SDLEnum)
 
+/**
+ *  Returns whether or not two enums are equal.
+ *
+ *  @param enumObj A SDLEnum object
+ *  @return YES if the two enums are equal. NO if not.
+ */
 - (BOOL)isEqualToEnum:(SDLEnum)enumObj;
 
 @end
diff --git a/SmartDeviceLink/SDLIAPSessionDelegate.h b/SmartDeviceLink/SDLIAPSessionDelegate.h
index b391a38fc..66d182aaa 100644
--- a/SmartDeviceLink/SDLIAPSessionDelegate.h
+++ b/SmartDeviceLink/SDLIAPSessionDelegate.h
@@ -9,7 +9,19 @@ NS_ASSUME_NONNULL_BEGIN
 
 @protocol SDLIAPSessionDelegate
 
+/**
+ *  Session initialized
+ *
+ *  @param session A SDLIAPSession object
+ */
 - (void)onSessionInitializationCompleteForSession:(SDLIAPSession *)session;
+
+
+/**
+ *  Session ended
+ *
+ *  @param session A SDLIAPSession object
+ */
 - (void)onSessionStreamsEnded:(SDLIAPSession *)session;
 
 @end
diff --git a/SmartDeviceLink/SDLIAPTransport.h b/SmartDeviceLink/SDLIAPTransport.h
index 06359edb0..ec32ae1f1 100644
--- a/SmartDeviceLink/SDLIAPTransport.h
+++ b/SmartDeviceLink/SDLIAPTransport.h
@@ -10,9 +10,19 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLIAPTransport : NSObject <SDLTransportType, SDLIAPSessionDelegate>
 
+/**
+ *  Session for transporting data between the app and Core.
+ */
 @property (nullable, strong, nonatomic) SDLIAPSession *controlSession;
+
+/**
+ *  Session for establishing a connection with Core. Once the connection has been established, the session is closed and a control session is established.
+ */
 @property (nullable, strong, nonatomic) SDLIAPSession *session;
 
+/**
+ *  The subscribed listener.
+ */
 @property (nullable, weak, nonatomic) id<SDLTransportDelegate> delegate;
 
 @end
diff --git a/SmartDeviceLink/SDLTCPTransport.h b/SmartDeviceLink/SDLTCPTransport.h
index 66a526da4..6349bb1a8 100644
--- a/SmartDeviceLink/SDLTCPTransport.h
+++ b/SmartDeviceLink/SDLTCPTransport.h
@@ -9,10 +9,28 @@ NS_ASSUME_NONNULL_BEGIN
     _Nullable CFSocketRef socket;
 }
 
+/**
+ *  Convenience init
+ *
+ *  @param hostName     The host name of Core
+ *  @param portNumber   The port number of Core
+ *  @return             A SDLTCPTransport object
+ */
 - (instancetype)initWithHostName:(NSString *)hostName portNumber:(NSString *)portNumber;
 
+/**
+ *  The host name of Core
+ */
 @property (strong, nonatomic) NSString *hostName;
+
+/**
+ *  The port number of Core
+ */
 @property (strong, nonatomic) NSString *portNumber;
+
+/**
+ *  The subscribed listener
+ */
 @property (nullable, weak, nonatomic) id<SDLTransportDelegate> delegate;
 
 @end