no message

17 files changed, 90 insertions, 21 deletions

diff --git a/SmartDeviceLink/SDLStationIDNumber.h b/SmartDeviceLink/SDLStationIDNumber.h
index ffd249347..22288c1db 100644
--- a/SmartDeviceLink/SDLStationIDNumber.h
+++ b/SmartDeviceLink/SDLStationIDNumber.h
@@ -13,6 +13,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLStationIDNumber : SDLRPCStruct
 
+/// Convenience init
+
+/// @param countryCode Binary Representation of ITU Country Code. USA Code is 001
+/// @param id Binary representation  of unique facility ID assigned by the FCC
+/// @return An SDLStationIDNumber object
 - (instancetype)initWithCountryCode:(nullable NSNumber<SDLInt> *)countryCode fccFacilityId:(nullable NSNumber<SDLInt> *)id;
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingMediaConfiguration.h b/SmartDeviceLink/SDLStreamingMediaConfiguration.h
index b000b6ba8..abe5ea799 100644
--- a/SmartDeviceLink/SDLStreamingMediaConfiguration.h
+++ b/SmartDeviceLink/SDLStreamingMediaConfiguration.h
@@ -18,14 +18,15 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  The type of rendering that CarWindow will perform. Depending on your app, you may need to try different ones for best performance
-
- - SDLCarWindowRenderingTypeLayer: Instead of rendering your UIViewController's view, this will render the layer using `renderInContext`
- - SDLCarWindowRenderingTypeViewAfterScreenUpdates: Renders your UIViewController's view using `drawViewHierarchyInRect:bounds afterScreenUpdates:YES`
- - SDLCarWindowRenderingTypeViewBeforeScreenUpdates: Renders your UIViewController's view using `drawViewHierarchyInRect:bounds afterScreenUpdates:NO`
  */
 typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) {
+    /// Instead of rendering your UIViewController's view, this will render the layer using renderInContext
     SDLCarWindowRenderingTypeLayer,
+
+    /// Renders your UIViewController's view using drawViewHierarchyInRect:bounds afterScreenUpdates:YES
     SDLCarWindowRenderingTypeViewAfterScreenUpdates,
+
+    /// Renders your UIViewController's view using drawViewHierarchyInRect:bounds afterScreenUpdates:NO
     SDLCarWindowRenderingTypeViewBeforeScreenUpdates
 };
 
diff --git a/SmartDeviceLink/SDLStreamingMediaManager.h b/SmartDeviceLink/SDLStreamingMediaManager.h
index 01628cfda..28e5abc5e 100644
--- a/SmartDeviceLink/SDLStreamingMediaManager.h
+++ b/SmartDeviceLink/SDLStreamingMediaManager.h
@@ -25,6 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 #pragma mark - Interface
 
+/// Manager to help control streaming media services.
 @interface SDLStreamingMediaManager : NSObject <SDLStreamingAudioManagerType>
 
 /**
diff --git a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
index 1c0eadc72..015353350 100644
--- a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
+++ b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h
@@ -12,14 +12,15 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  A flag determining how video and audio streaming should be encrypted
-
- - SDLStreamingEncryptionFlagNone: It should not be encrypted at all
- - SDLStreamingEncryptionFlagAuthenticateOnly: It should use SSL/TLS only to authenticate
- - SDLStreamingEncryptionFlagAuthenticateAndEncrypt: All data on these services should be encrypted using SSL/TLS
  */
 typedef NS_ENUM(NSInteger, SDLStreamingEncryptionFlag) {
+    /// It should not be encrypted at all
     SDLStreamingEncryptionFlagNone,
+
+    /// It should use SSL/TLS only to authenticate
     SDLStreamingEncryptionFlagAuthenticateOnly,
+
+    /// All data on these services should be encrypted using SSL/TLS
     SDLStreamingEncryptionFlagAuthenticateAndEncrypt
 };
 
@@ -36,20 +37,39 @@ extern NSString *const SDLLockScreenManagerWillDismissLockScreenViewController;
 extern NSString *const SDLLockScreenManagerDidDismissLockScreenViewController;
 
 typedef NSString SDLVideoStreamManagerState;
+/// Streaming state stopped
 extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateStopped;
+
+/// Streaming state starting
 extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateStarting;
+
+/// Streaming state ready
 extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateReady;
+
+/// Streaming state suspended
 extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateSuspended;
+
+/// Streaming state shutting down
 extern SDLVideoStreamManagerState *const SDLVideoStreamManagerStateShuttingDown;
 
 typedef NSString SDLAudioStreamManagerState;
+/// Audio state stopped
 extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateStopped;
+
+/// Audio state starting
 extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateStarting;
+
+/// Audio state ready
 extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateReady;
+
+/// Audio state shutting down
 extern SDLAudioStreamManagerState *const SDLAudioStreamManagerStateShuttingDown;
 
 typedef NSString SDLAppState;
+/// App state inactive
 extern SDLAppState *const SDLAppStateInactive;
+
+/// App state active
 extern SDLAppState *const SDLAppStateActive;
 
 NS_ASSUME_NONNULL_END
diff --git a/SmartDeviceLink/SDLStreamingMediaManagerDataSource.h b/SmartDeviceLink/SDLStreamingMediaManagerDataSource.h
index 7fdf13e38..8d7b0944f 100644
--- a/SmartDeviceLink/SDLStreamingMediaManagerDataSource.h
+++ b/SmartDeviceLink/SDLStreamingMediaManagerDataSource.h
@@ -13,6 +13,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// A data source for the streaming manager's preferred resolutions and preferred formats.
 @protocol SDLStreamingMediaManagerDataSource <NSObject>
 
 /**
diff --git a/SmartDeviceLink/SDLSubscribeButton.h b/SmartDeviceLink/SDLSubscribeButton.h
index 4dc6280c5..75c058d4d 100644
--- a/SmartDeviceLink/SDLSubscribeButton.h
+++ b/SmartDeviceLink/SDLSubscribeButton.h
@@ -69,6 +69,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithHandler:(nullable SDLRPCButtonNotificationHandler)handler;
 
+/// Construct a SDLSubscribeButton with a handler callback when an event occurs with a button name.
+///
+/// @param buttonName The name of the button to subscribe to
+/// @param handler A callback that will be called when a button event occurs for the subscribed button
+/// @return An SDLSubscribeButton object
 - (instancetype)initWithButtonName:(SDLButtonName)buttonName handler:(nullable SDLRPCButtonNotificationHandler)handler;
 
 /**
diff --git a/SmartDeviceLink/SDLSupportedSeat.h b/SmartDeviceLink/SDLSupportedSeat.h
index 63badc582..c17689e4c 100644
--- a/SmartDeviceLink/SDLSupportedSeat.h
+++ b/SmartDeviceLink/SDLSupportedSeat.h
@@ -9,18 +9,18 @@
  */
 typedef SDLEnum SDLSupportedSeat SDL_SWIFT_ENUM __deprecated;
 
-/**
- * @abstract Save current seat postions and settings to seat memory.
- */
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
+/**
+* @abstract Save current seat postions and settings to seat memory.
+*/
 extern SDLSupportedSeat const SDLSupportedSeatDriver;
 #pragma clang diagnostic pop
 
-/**
- * @abstract Restore / apply the seat memory settings to the current seat.
- */
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
+/**
+* @abstract Restore / apply the seat memory settings to the current seat.
+*/
 extern SDLSupportedSeat const SDLSupportedSeatFrontPassenger;
 #pragma clang diagnostic pop
diff --git a/SmartDeviceLink/SDLSyncMsgVersion.h b/SmartDeviceLink/SDLSyncMsgVersion.h
index 5efcfde38..7ef41b21d 100644
--- a/SmartDeviceLink/SDLSyncMsgVersion.h
+++ b/SmartDeviceLink/SDLSyncMsgVersion.h
@@ -14,6 +14,12 @@ NS_ASSUME_NONNULL_BEGIN
 __deprecated_msg("Use SDLMsgVersion instead")
 @interface SDLSyncMsgVersion : SDLRPCStruct
 
+/// Convenience init to describe the SDL version
+///
+/// @param majorVersion The major version indicates versions that is not-compatible to previous versions
+/// @param minorVersion The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)
+/// @param patchVersion Allows backward-compatible fixes to the API without increasing the minor version of the interface
+/// @return An SDLSyncMsgVersion object
 - (instancetype)initWithMajorVersion:(UInt8)majorVersion minorVersion:(UInt8)minorVersion patchVersion:(UInt8)patchVersion;
 
 /**
diff --git a/SmartDeviceLink/SDLSyncPData.h b/SmartDeviceLink/SDLSyncPData.h
index c19fae453..6dbad57e0 100644
--- a/SmartDeviceLink/SDLSyncPData.h
+++ b/SmartDeviceLink/SDLSyncPData.h
@@ -6,7 +6,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/*
+/**
  *  Allows binary data in the form of SyncP packets to be sent to the SYNC module. Binary data is in binary part of hybrid msg.
  *
  *  *** DEPRECATED ***
diff --git a/SmartDeviceLink/SDLSystemRequest.h b/SmartDeviceLink/SDLSystemRequest.h
index b029d37c9..75cd10a6c 100644
--- a/SmartDeviceLink/SDLSystemRequest.h
+++ b/SmartDeviceLink/SDLSystemRequest.h
@@ -5,7 +5,7 @@
 
 #import "SDLRequestType.h"
 
-/*
+/**
  *  An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)
  *
  *  @since SmartDeviceLink 3.0
diff --git a/SmartDeviceLink/SDLTemplateColorScheme.h b/SmartDeviceLink/SDLTemplateColorScheme.h
index d62420326..db51327a9 100644
--- a/SmartDeviceLink/SDLTemplateColorScheme.h
+++ b/SmartDeviceLink/SDLTemplateColorScheme.h
@@ -15,8 +15,15 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// A color scheme for all display layout templates.
 @interface SDLTemplateColorScheme : SDLRPCStruct
 
+/// Convenience init
+///
+/// @param primaryColor This must always be your primary brand color
+/// @param secondaryColor This may be an accent or complimentary color to your primary brand color
+/// @param backgroundColor he background color to be used on the template
+/// @return An SDLTemplateColorScheme
 - (instancetype)initWithPrimaryRGBColor:(SDLRGBColor *)primaryColor secondaryRGBColor:(SDLRGBColor *)secondaryColor backgroundRGBColor:(SDLRGBColor *)backgroundColor;
 - (instancetype)initWithPrimaryColor:(UIColor *)primaryColor secondaryColor:(UIColor *)secondaryColor backgroundColor:(UIColor *)backgroundColor;
 
diff --git a/SmartDeviceLink/SDLTurn.h b/SmartDeviceLink/SDLTurn.h
index f0cd7dcf5..b86d64695 100644
--- a/SmartDeviceLink/SDLTurn.h
+++ b/SmartDeviceLink/SDLTurn.h
@@ -12,6 +12,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface SDLTurn : SDLRPCStruct
 
+/// Convenience init to UpdateTurnList for navigation
+///
+/// @param navigationText Individual turn text. Must provide at least text or icon for a given turn
+/// @param icon Individual turn icon. Must provide at least text or icon for a given turn
+/// @return An SDLTurn object
 - (instancetype)initWithNavigationText:(nullable NSString *)navigationText turnIcon:(nullable SDLImage *)icon;
 
 /**
diff --git a/SmartDeviceLink/SDLTurnSignal.h b/SmartDeviceLink/SDLTurnSignal.h
index b8d50c610..daca0b05b 100644
--- a/SmartDeviceLink/SDLTurnSignal.h
+++ b/SmartDeviceLink/SDLTurnSignal.h
@@ -8,27 +8,27 @@
 
 #import "SDLEnum.h"
 
-/*
+/**
  *  Enumeration that describes the status of the turn light indicator.
  */
 typedef SDLEnum SDLTurnSignal SDL_SWIFT_ENUM;
 
-/*
+/**
  *  Turn signal is OFF
  */
 extern SDLTurnSignal const SDLTurnSignalOff;
 
-/*
+/**
  *  Left turn signal is on
  */
 extern SDLTurnSignal const SDLTurnSignalLeft;
 
-/*
+/**
  *  Right turn signal is on
  */
 extern SDLTurnSignal const SDLTurnSignalRight;
 
-/*
+/**
  *  Both signals (left and right) are on
  */
 extern SDLTurnSignal const SDLTurnSignalBoth;
diff --git a/SmartDeviceLink/SDLUnsubscribeButton.h b/SmartDeviceLink/SDLUnsubscribeButton.h
index 23d4cbf3b..9fd78ec25 100644
--- a/SmartDeviceLink/SDLUnsubscribeButton.h
+++ b/SmartDeviceLink/SDLUnsubscribeButton.h
@@ -24,6 +24,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLUnsubscribeButton : SDLRPCRequest
 
+/// Convenience init to unsubscribe from a subscription button
+///
+/// @param buttonName A name of the button to unsubscribe from
+/// @return A name of the button to unsubscribe from
 - (instancetype)initWithButtonName:(SDLButtonName)buttonName;
 
 /**
diff --git a/SmartDeviceLink/SDLUpdateTurnList.h b/SmartDeviceLink/SDLUpdateTurnList.h
index 96d54a55a..0133e0e2f 100644
--- a/SmartDeviceLink/SDLUpdateTurnList.h
+++ b/SmartDeviceLink/SDLUpdateTurnList.h
@@ -17,6 +17,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLUpdateTurnList : SDLRPCRequest
 
+/// Convenience init to update a list of maneuvers for navigation
+///
+/// @param turnList A struct used in UpdateTurnList for Turn-by-Turn navigation applications
+/// @param softButtons An array of softbuttons
 - (instancetype)initWithTurnList:(nullable NSArray<SDLTurn *> *)turnList softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
 
 /**
diff --git a/SmartDeviceLink/SDLVideoStreamingFormat.h b/SmartDeviceLink/SDLVideoStreamingFormat.h
index 9cc3cb7cc..958ae43b2 100644
--- a/SmartDeviceLink/SDLVideoStreamingFormat.h
+++ b/SmartDeviceLink/SDLVideoStreamingFormat.h
@@ -28,6 +28,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (strong, nonatomic) SDLVideoStreamingCodec codec;
 
+/// Convenience init
+///
+/// @param codec Codec type, see VideoStreamingCodec
+/// @param protocol Protocol type, see VideoStreamingProtocol
+/// @return An SDLVideoStreamingFormat object
 - (instancetype)initWithCodec:(SDLVideoStreamingCodec)codec protocol:(SDLVideoStreamingProtocol)protocol;
 
 @end
diff --git a/SmartDeviceLink/SDLVoiceCommand.h b/SmartDeviceLink/SDLVoiceCommand.h
index 252fbaeae..b29ec6fd1 100644
--- a/SmartDeviceLink/SDLVoiceCommand.h
+++ b/SmartDeviceLink/SDLVoiceCommand.h
@@ -24,6 +24,11 @@ typedef void(^SDLVoiceCommandSelectionHandler)(void);
  */
 @property (copy, nonatomic, readonly, nullable) SDLVoiceCommandSelectionHandler handler;
 
+/// Convenience init
+///
+/// @param voiceCommands The strings the user can say to activate this voice command
+/// @param handler The handler that will be called when the command is activated
+/// @return An SDLVoiceCommand object
 - (instancetype)initWithVoiceCommands:(NSArray<NSString *> *)voiceCommands handler:(SDLVoiceCommandSelectionHandler)handler;
 
 @end