summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Gluck <justin.gluck@livio.io>2019-10-29 14:46:31 -0400
committerJustin Gluck <justin.gluck@livio.io>2019-10-29 14:46:31 -0400
commit07325db25f75487831a9459c60895730b43bc3ec (patch)
tree643915073178661adc7d376d427cd728ba26606d
parent0ee371ffe448c12472a6ef705f76639136812064 (diff)
downloadsdl_ios-07325db25f75487831a9459c60895730b43bc3ec.tar.gz
part 3
-rw-r--r--SmartDeviceLink/SDLGetAppServiceDataResponse.h2
-rw-r--r--SmartDeviceLink/SDLGetDTCs.h9
-rw-r--r--SmartDeviceLink/SDLGetFileResponse.h4
-rw-r--r--SmartDeviceLink/SDLGetInteriorVehicleData.h27
-rw-r--r--SmartDeviceLink/SDLGetInteriorVehicleDataConsent.h9
-rw-r--r--SmartDeviceLink/SDLGetInteriorVehicleDataConsentResponse.h3
-rw-r--r--SmartDeviceLink/SDLGetSystemCapability.h2
-rw-r--r--SmartDeviceLink/SDLGetWayPoints.h7
-rw-r--r--SmartDeviceLink/SDLHMISettingsControlCapabilities.h3
-rw-r--r--SmartDeviceLink/SDLHapticRect.h5
-rw-r--r--SmartDeviceLink/SDLHybridAppPreference.h6
-rw-r--r--SmartDeviceLink/SDLImageResolution.h5
-rw-r--r--SmartDeviceLink/SDLKeyboardDelegate.h5
-rw-r--r--SmartDeviceLink/SDLLifecycleConfiguration.h4
-rw-r--r--SmartDeviceLink/SDLLightCapabilities.h3
-rw-r--r--SmartDeviceLink/SDLLightControlCapabilities.h4
-rw-r--r--SmartDeviceLink/SDLLightControlData.h3
-rw-r--r--SmartDeviceLink/SDLLightState.h1
-rw-r--r--SmartDeviceLink/SDLLockScreenViewController.h2
-rw-r--r--SmartDeviceLink/SDLLogConfiguration.h1
-rw-r--r--SmartDeviceLink/SDLLogFileModule.h1
-rw-r--r--SmartDeviceLink/SDLLogFilter.h4
-rw-r--r--SmartDeviceLink/SDLManager.h6
-rw-r--r--SmartDeviceLink/SDLMenuCell.h6
-rw-r--r--SmartDeviceLink/SDLMenuConfiguration.h1
-rw-r--r--SmartDeviceLink/SDLMenuManagerConstants.h27
-rw-r--r--SmartDeviceLink/SDLMenuParams.h10
-rw-r--r--SmartDeviceLink/SDLMetadataTags.h2
-rw-r--r--SmartDeviceLink/SDLNavigationAction.h18
-rw-r--r--SmartDeviceLink/SDLNavigationCapability.h5
30 files changed, 158 insertions, 27 deletions
diff --git a/SmartDeviceLink/SDLGetAppServiceDataResponse.h b/SmartDeviceLink/SDLGetAppServiceDataResponse.h
index ca94c1790..30b2c6cc8 100644
--- a/SmartDeviceLink/SDLGetAppServiceDataResponse.h
+++ b/SmartDeviceLink/SDLGetAppServiceDataResponse.h
@@ -12,7 +12,7 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**
* This response includes the data that was requested from the specific service.
*/
@interface SDLGetAppServiceDataResponse : SDLRPCResponse
diff --git a/SmartDeviceLink/SDLGetDTCs.h b/SmartDeviceLink/SDLGetDTCs.h
index 3cc55e520..150b04d55 100644
--- a/SmartDeviceLink/SDLGetDTCs.h
+++ b/SmartDeviceLink/SDLGetDTCs.h
@@ -18,8 +18,17 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLGetDTCs : SDLRPCRequest
+/// Convenience init.
+///
+/// @param name Name of the module to receive the DTC form
+/// @return An SDLGetDTCs object
- (instancetype)initWithECUName:(UInt16)name;
+/// Convenience init with all properties.
+///
+/// @param name Name of the module to receive the DTC form
+/// @param mask DTC Mask Byte to be sent in diagnostic request to module
+/// @return An SDLGetDTCs object
- (instancetype)initWithECUName:(UInt16)name mask:(UInt8)mask;
/**
diff --git a/SmartDeviceLink/SDLGetFileResponse.h b/SmartDeviceLink/SDLGetFileResponse.h
index cf6a5cef9..52a2fb5f4 100644
--- a/SmartDeviceLink/SDLGetFileResponse.h
+++ b/SmartDeviceLink/SDLGetFileResponse.h
@@ -10,9 +10,11 @@
#import "SDLFileType.h"
-
NS_ASSUME_NONNULL_BEGIN
+/// Response to GetFiles
+///
+/// @since RPC 5.1
@interface SDLGetFileResponse : SDLRPCResponse
/**
diff --git a/SmartDeviceLink/SDLGetInteriorVehicleData.h b/SmartDeviceLink/SDLGetInteriorVehicleData.h
index 143a2468f..baddec94d 100644
--- a/SmartDeviceLink/SDLGetInteriorVehicleData.h
+++ b/SmartDeviceLink/SDLGetInteriorVehicleData.h
@@ -18,16 +18,43 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLGetInteriorVehicleData : SDLRPCRequest
+/// Convenience init to get information of a particular module type with a module ID.
+///
+/// @param moduleType The type of a RC module to retrieve module data from the vehicle
+/// @param moduleId Id of a module, published by System Capability
+/// @return An SDLGetInteriorVehicleData object
- (instancetype)initWithModuleType:(SDLModuleType)moduleType moduleId:(NSString *)moduleId;
+/// Convenience init to get information and subscribe to a particular module type with a module ID.
+///
+/// @param moduleType The type of a RC module to retrieve module data from the vehicle
+/// @param moduleId Id of a module, published by System Capability
+/// @return An SDLGetInteriorVehicleData object
- (instancetype)initAndSubscribeToModuleType:(SDLModuleType)moduleType moduleId:(NSString *)moduleId;
+/// Convenience init to unsubscribe from particular module with a module ID.
+///
+/// @param moduleType The type of a RC module to retrieve module data from the vehicle
+/// @param moduleId Id of a module, published by System Capability
+/// @return An SDLGetInteriorVehicleData object
- (instancetype)initAndUnsubscribeToModuleType:(SDLModuleType)moduleType moduleId:(NSString *)moduleId;
+/// Convenience init to get information of a particular module type.
+///
+/// @param moduleType The type of a RC module to retrieve module data from the vehicle
+/// @return An SDLGetInteriorVehicleData object
- (instancetype)initWithModuleType:(SDLModuleType)moduleType __deprecated_msg("Use initWithModuleType:moduleId: instead");
+/// Convenience init to get information and subscribe to a particular module type.
+///
+/// @param moduleType The type of a RC module to retrieve module data from the vehicle
+/// @return An SDLGetInteriorVehicleData object
- (instancetype)initAndSubscribeToModuleType:(SDLModuleType)moduleType __deprecated_msg("Use initAndSubscribeToModuleType:moduleId: instead");
+/// Convenience init to unsubscribe from particular module type.
+///
+/// @param moduleType The type of a RC module to retrieve module data from the vehicle
+/// @return An SDLGetInteriorVehicleData object
- (instancetype)initAndUnsubscribeToModuleType:(SDLModuleType)moduleType __deprecated_msg("Use initAndUnsubscribeToModuleType:moduleId:");
/**
diff --git a/SmartDeviceLink/SDLGetInteriorVehicleDataConsent.h b/SmartDeviceLink/SDLGetInteriorVehicleDataConsent.h
index ff647fcde..b3ab2342a 100644
--- a/SmartDeviceLink/SDLGetInteriorVehicleDataConsent.h
+++ b/SmartDeviceLink/SDLGetInteriorVehicleDataConsent.h
@@ -11,8 +11,17 @@
NS_ASSUME_NONNULL_BEGIN
+
+/// This RPC allows you to get consent to control a certian module
+///
+/// @since RPC 6.0
@interface SDLGetInteriorVehicleDataConsent : SDLRPCRequest
+/// Convenience init to get consent to control a module
+///
+/// @param moduleType The module type that the app requests to control
+/// @param moduleIds Ids of a module of same type, published by System Capability
+/// @return An SDLGetInteriorVehicleDataConsent object
- (instancetype)initWithModuleType:(SDLModuleType)moduleType moduleIds:(NSArray<NSString *> *)moduleIds;
/**
diff --git a/SmartDeviceLink/SDLGetInteriorVehicleDataConsentResponse.h b/SmartDeviceLink/SDLGetInteriorVehicleDataConsentResponse.h
index 7aee83e57..a22ec39d9 100644
--- a/SmartDeviceLink/SDLGetInteriorVehicleDataConsentResponse.h
+++ b/SmartDeviceLink/SDLGetInteriorVehicleDataConsentResponse.h
@@ -10,6 +10,9 @@
NS_ASSUME_NONNULL_BEGIN
+/// Response to GetInteriorVehicleDataConsent
+///
+/// @since RPC 6.0
@interface SDLGetInteriorVehicleDataConsentResponse : SDLRPCResponse
/**
diff --git a/SmartDeviceLink/SDLGetSystemCapability.h b/SmartDeviceLink/SDLGetSystemCapability.h
index b81704e35..e47484b25 100644
--- a/SmartDeviceLink/SDLGetSystemCapability.h
+++ b/SmartDeviceLink/SDLGetSystemCapability.h
@@ -13,7 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
-/*
+/**SDLGetWayPoints.
* Request for expanded information about a supported system/HMI capability
*/
@interface SDLGetSystemCapability : SDLRPCRequest
diff --git a/SmartDeviceLink/SDLGetWayPoints.h b/SmartDeviceLink/SDLGetWayPoints.h
index be84df565..8d5fd56bf 100644
--- a/SmartDeviceLink/SDLGetWayPoints.h
+++ b/SmartDeviceLink/SDLGetWayPoints.h
@@ -7,8 +7,15 @@
NS_ASSUME_NONNULL_BEGIN
+/// This RPC allows you to get waypoint data
+///
+/// @since 4.1
@interface SDLGetWayPoints : SDLRPCRequest
+/// Convenience init to get waypoints.
+///
+/// @param type To request for either the destination only or for all waypoints including destination
+/// @return An SDLGetWayPoints object
- (instancetype)initWithType:(SDLWayPointType)type;
/**
diff --git a/SmartDeviceLink/SDLHMISettingsControlCapabilities.h b/SmartDeviceLink/SDLHMISettingsControlCapabilities.h
index 4f0f0cf45..b79ec606b 100644
--- a/SmartDeviceLink/SDLHMISettingsControlCapabilities.h
+++ b/SmartDeviceLink/SDLHMISettingsControlCapabilities.h
@@ -6,6 +6,9 @@
NS_ASSUME_NONNULL_BEGIN
+/// HMI data struct for HMI control settings
+///
+/// @since 5.0
@interface SDLHMISettingsControlCapabilities : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLHapticRect.h b/SmartDeviceLink/SDLHapticRect.h
index 44de77182..ca7182ade 100644
--- a/SmartDeviceLink/SDLHapticRect.h
+++ b/SmartDeviceLink/SDLHapticRect.h
@@ -19,6 +19,11 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLHapticRect : SDLRPCStruct
+/// Convenience init with all parameters
+///
+/// @param id A user control spatial identifier
+/// @param rect The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs
+/// @return An SDLHapticRect object
- (instancetype)initWithId:(UInt32)id rect:(SDLRectangle *)rect;
/**
diff --git a/SmartDeviceLink/SDLHybridAppPreference.h b/SmartDeviceLink/SDLHybridAppPreference.h
index e07987e78..ac456a237 100644
--- a/SmartDeviceLink/SDLHybridAppPreference.h
+++ b/SmartDeviceLink/SDLHybridAppPreference.h
@@ -13,17 +13,17 @@
*/
typedef SDLEnum SDLHybridAppPreference SDL_SWIFT_ENUM;
-/*
+/**SDLImageResolution.h
* App preference of mobile.
*/
extern SDLHybridAppPreference const SDLHybridAppPreferenceMobile;
-/*
+/**
* App preference of cloud.
*/
extern SDLHybridAppPreference const SDLHybridAppPreferenceCloud;
-/*
+/**
* App preference of both. Allows both the mobile and the cloud versions of the app to attempt to connect at the same time, however the first app that is registered is the one that is allowed to stay registered.
*/
extern SDLHybridAppPreference const SDLHybridAppPreferenceBoth;
diff --git a/SmartDeviceLink/SDLImageResolution.h b/SmartDeviceLink/SDLImageResolution.h
index 2e68bfdc6..3dc3c3413 100644
--- a/SmartDeviceLink/SDLImageResolution.h
+++ b/SmartDeviceLink/SDLImageResolution.h
@@ -25,6 +25,11 @@ NS_ASSUME_NONNULL_BEGIN
*/
@property (strong, nonatomic) NSNumber<SDLInt> *resolutionHeight;
+/// Convenience init with all parametersSDLKeyboardDelegate.h
+///
+/// @param width Resolution width
+/// @param height Resolution height
+/// @return An SDLImageResolution object
- (instancetype)initWithWidth:(uint16_t)width height:(uint16_t)height;
@end
diff --git a/SmartDeviceLink/SDLKeyboardDelegate.h b/SmartDeviceLink/SDLKeyboardDelegate.h
index 4af085ab4..95d8e826f 100644
--- a/SmartDeviceLink/SDLKeyboardDelegate.h
+++ b/SmartDeviceLink/SDLKeyboardDelegate.h
@@ -35,11 +35,10 @@ typedef void(^SDLKeyboardAutoCompleteResultsHandler)(NSArray<NSString *> *_Nulla
*/
typedef void(^SDLKeyboardCharacterSetCompletionHandler)(NSArray<NSString *> *_Nullable updatedCharacterSet);
+/// A protocol with available keyboard delegate methods and properties
@protocol SDLKeyboardDelegate <NSObject>
-//
-
-/**
+/**SDLLifecycleConfiguration.h
The keyboard session completed with some input.
This will be sent upon ENTRY_SUBMITTED or ENTRY_VOICE. If the event is ENTRY_VOICE, the user requested to start a voice session in order to submit input to this keyboard. This MUST be handled by you. Start an Audio Pass Thru session if supported.
diff --git a/SmartDeviceLink/SDLLifecycleConfiguration.h b/SmartDeviceLink/SDLLifecycleConfiguration.h
index 36ad3565e..d91dc6bd3 100644
--- a/SmartDeviceLink/SDLLifecycleConfiguration.h
+++ b/SmartDeviceLink/SDLLifecycleConfiguration.h
@@ -19,8 +19,12 @@
NS_ASSUME_NONNULL_BEGIN
+/// List of secondary transports
typedef NS_OPTIONS(NSUInteger, SDLSecondaryTransports) {
+ /// No secondary transport
SDLSecondaryTransportsNone = 0,
+
+ /// TCP as secondary transport
SDLSecondaryTransportsTCP = 1 << 0
};
diff --git a/SmartDeviceLink/SDLLightCapabilities.h b/SmartDeviceLink/SDLLightCapabilities.h
index 0bdac1a62..19f3024eb 100644
--- a/SmartDeviceLink/SDLLightCapabilities.h
+++ b/SmartDeviceLink/SDLLightCapabilities.h
@@ -7,6 +7,9 @@
NS_ASSUME_NONNULL_BEGIN
+/// Current Light capabilities.
+///
+/// @since RPC 5.0
@interface SDLLightCapabilities : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLLightControlCapabilities.h b/SmartDeviceLink/SDLLightControlCapabilities.h
index d50e14db9..3466ca4dd 100644
--- a/SmartDeviceLink/SDLLightControlCapabilities.h
+++ b/SmartDeviceLink/SDLLightControlCapabilities.h
@@ -8,6 +8,10 @@
NS_ASSUME_NONNULL_BEGIN
+
+///Current light control capabilitie. If included, the platform supports light controls
+///
+/// @since RPC 5.0
@interface SDLLightControlCapabilities : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLLightControlData.h b/SmartDeviceLink/SDLLightControlData.h
index 49d2fe692..215e869db 100644
--- a/SmartDeviceLink/SDLLightControlData.h
+++ b/SmartDeviceLink/SDLLightControlData.h
@@ -7,6 +7,9 @@
NS_ASSUME_NONNULL_BEGIN
+/// Data about the current light controls
+///
+/// @since 5.0
@interface SDLLightControlData : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLLightState.h b/SmartDeviceLink/SDLLightState.h
index c44ebf48e..a21957e24 100644
--- a/SmartDeviceLink/SDLLightState.h
+++ b/SmartDeviceLink/SDLLightState.h
@@ -10,6 +10,7 @@
NS_ASSUME_NONNULL_BEGIN
+/// Current light control state
@interface SDLLightState : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLLockScreenViewController.h b/SmartDeviceLink/SDLLockScreenViewController.h
index 2b19537b5..910f83a0e 100644
--- a/SmartDeviceLink/SDLLockScreenViewController.h
+++ b/SmartDeviceLink/SDLLockScreenViewController.h
@@ -10,8 +10,10 @@
NS_ASSUME_NONNULL_BEGIN
+/// The view controller fo the lockscreen.
@interface SDLLockScreenViewController : UIViewController
+/// A block that can be used to close the lockscreen when the user swipes on the lockscreen.
typedef void (^SwipeGestureCallbackBlock)(void);
/**
diff --git a/SmartDeviceLink/SDLLogConfiguration.h b/SmartDeviceLink/SDLLogConfiguration.h
index f92b30be5..4b6b030cf 100644
--- a/SmartDeviceLink/SDLLogConfiguration.h
+++ b/SmartDeviceLink/SDLLogConfiguration.h
@@ -17,6 +17,7 @@
NS_ASSUME_NONNULL_BEGIN
+/// Information about the current logging configuration
@interface SDLLogConfiguration : NSObject <NSCopying>
/**
diff --git a/SmartDeviceLink/SDLLogFileModule.h b/SmartDeviceLink/SDLLogFileModule.h
index aaad78470..22ff9af05 100644
--- a/SmartDeviceLink/SDLLogFileModule.h
+++ b/SmartDeviceLink/SDLLogFileModule.h
@@ -13,6 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
+/// Log file module information
@interface SDLLogFileModule : NSObject
/**
diff --git a/SmartDeviceLink/SDLLogFilter.h b/SmartDeviceLink/SDLLogFilter.h
index da067f1c7..b3511cc0e 100644
--- a/SmartDeviceLink/SDLLogFilter.h
+++ b/SmartDeviceLink/SDLLogFilter.h
@@ -16,8 +16,12 @@
NS_ASSUME_NONNULL_BEGIN
+/// Log filter information
@interface SDLLogFilter : NSObject
+/// A block that takes in a log model and returns whether or not the log passes the filter and should therefore be logged.
+///
+/// Optional
@property (strong, nonatomic, readonly) SDLLogFilterBlock filter;
- (instancetype)init NS_UNAVAILABLE;
diff --git a/SmartDeviceLink/SDLManager.h b/SmartDeviceLink/SDLManager.h
index 0e3f22f3e..3262ff26d 100644
--- a/SmartDeviceLink/SDLManager.h
+++ b/SmartDeviceLink/SDLManager.h
@@ -28,10 +28,12 @@
NS_ASSUME_NONNULL_BEGIN
-
+/// The block called when the manager is ready to be used or an error occurs while attempting to become ready.
+///
+/// @param success a bool value if the set up succeeded
+/// @param error the error is any exists
typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error);
-
@interface SDLManager : NSObject
/**
diff --git a/SmartDeviceLink/SDLMenuCell.h b/SmartDeviceLink/SDLMenuCell.h
index 5d5d1ea2b..c91384742 100644
--- a/SmartDeviceLink/SDLMenuCell.h
+++ b/SmartDeviceLink/SDLMenuCell.h
@@ -15,8 +15,14 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+The handler to run when a menu item is selected.
+
+@param triggerSource The trigger source of the selection
+*/
typedef void(^SDLMenuCellSelectionHandler)(SDLTriggerSource triggerSource);
+/// A menu cell item for the drop down menu.
@interface SDLMenuCell : NSObject
/**
diff --git a/SmartDeviceLink/SDLMenuConfiguration.h b/SmartDeviceLink/SDLMenuConfiguration.h
index 6aefdb2f4..d3614001a 100644
--- a/SmartDeviceLink/SDLMenuConfiguration.h
+++ b/SmartDeviceLink/SDLMenuConfiguration.h
@@ -10,6 +10,7 @@
NS_ASSUME_NONNULL_BEGIN
+/// Defines how the menu is configured
@interface SDLMenuConfiguration : NSObject
/**
diff --git a/SmartDeviceLink/SDLMenuManagerConstants.h b/SmartDeviceLink/SDLMenuManagerConstants.h
index 8ff19ea82..4124b96f5 100644
--- a/SmartDeviceLink/SDLMenuManagerConstants.h
+++ b/SmartDeviceLink/SDLMenuManagerConstants.h
@@ -8,21 +8,34 @@
#import <Foundation/Foundation.h>
-/**
- Dynamic Menu Manager Mode
- - SDLDynamicMenuUpdatesModeForceOn: Forces on compatibility mode. This will force the menu manager to delete and re-add each menu item for every menu update. This mode is generally not advised due to performance issues.
- - SDLDynamicMenuUpdatesModeForceOn: This mode forces the menu manager to always dynamically update menu items for each menu update. This will provide the best performance but may cause ordering issues on some SYNC Gen 3 head units.
- - SDLDynamicMenuUpdatesModeForceOff: This mode checks whether the phone is connected to a SYNC Gen 3 head unit, which has known menu ordering issues. If it is, it will always delete and re-add every menu item, if not, it will dynamically update the menus.
- */
+/// Dynamic Menu Manager Mode
+///
+/// When on this feature will smart arrange a new menu comparing it to the old menu if one exists.
typedef NS_ENUM(NSUInteger, SDLDynamicMenuUpdatesMode) {
+
+ /// Forces on compatibility mode. This will force the menu manager to delete and re-add each menu item for every menu update. This mode is generally not advised due to performance issues.
SDLDynamicMenuUpdatesModeForceOn = 0,
+
+ /// This mode forces the menu manager to always dynamically update menu items for each menu update. This will provide the best performance but may cause ordering issues on some SYNC Gen 3 head units.
SDLDynamicMenuUpdatesModeForceOff,
+
+ /// This mode checks whether the phone is connected to a SYNC Gen 3 head unit, which has known menu ordering issues. If it is, it will always delete and re-add every menu item, if not, it will dynamically update the menus.
SDLDynamicMenuUpdatesModeOnWithCompatibility
};
-typedef NS_ENUM(NSUInteger, MenuCellState) {
+
+/// Menu cell state
+///
+/// Cell state that tells the menu manager what it should do with a given SDLMenuCell
+typedef NS_ENUM(NSUInteger, MenuCellState) {\
+
+ /// Marks the cell to be deleted
MenuCellStateDelete = 0,
+
+ /// Marks the cell to be added
MenuCellStateAdd,
+
+ /// Marks the cell to be kept
MenuCellStateKeep
};
diff --git a/SmartDeviceLink/SDLMenuParams.h b/SmartDeviceLink/SDLMenuParams.h
index 60f05d426..cb64be8c2 100644
--- a/SmartDeviceLink/SDLMenuParams.h
+++ b/SmartDeviceLink/SDLMenuParams.h
@@ -14,8 +14,18 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLMenuParams : SDLRPCStruct
+/// Convenience init.
+///
+/// @param menuName The menu name
+/// @return An instance of the add submenu class
- (instancetype)initWithMenuName:(NSString *)menuName;
+/// Convenience init with all parmeters.SDLMetadataTags.h
+///
+/// @param menuName The menu name
+/// @param parentId The unique ID of an existing submenu to which a command will be added
+/// @param position The position within the items of the parent Command Menu
+/// @return An instance of the add submenu class
- (instancetype)initWithMenuName:(NSString *)menuName parentId:(UInt32)parentId position:(UInt16)position;
/**
diff --git a/SmartDeviceLink/SDLMetadataTags.h b/SmartDeviceLink/SDLMetadataTags.h
index 50f5830f8..6d707c7c2 100644
--- a/SmartDeviceLink/SDLMetadataTags.h
+++ b/SmartDeviceLink/SDLMetadataTags.h
@@ -11,6 +11,7 @@
NS_ASSUME_NONNULL_BEGIN
+/// App defined metadata information
@interface SDLMetadataTags : SDLRPCStruct
/**
@@ -18,6 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
*/
- (instancetype)initWithTextFieldTypes:(nullable NSArray<SDLMetadataType> *)mainField1 mainField2:(nullable NSArray<SDLMetadataType> *)mainField2;
+/// Constructs a newly allocated SDLMetadataType with all parametersSDLNavigationAction.h
- (instancetype)initWithTextFieldTypes:(nullable NSArray<SDLMetadataType> *)mainField1 mainField2:(nullable NSArray<SDLMetadataType> *)mainField2 mainField3:(nullable NSArray<SDLMetadataType> *)mainField3 mainField4:(nullable NSArray<SDLMetadataType> *)mainField4;
/**
diff --git a/SmartDeviceLink/SDLNavigationAction.h b/SmartDeviceLink/SDLNavigationAction.h
index 922ab404b..c013770f5 100644
--- a/SmartDeviceLink/SDLNavigationAction.h
+++ b/SmartDeviceLink/SDLNavigationAction.h
@@ -8,42 +8,42 @@
#import "SDLEnum.h"
-/*
+/**
* A navigation action.
*/
typedef SDLEnum SDLNavigationAction SDL_SWIFT_ENUM;
-/*
+/**
* Using this action plus a supplied direction can give the type of turn.
*/
extern SDLNavigationAction const SDLNavigationActionTurn;
-/*
+/**
* A navigation action of exit.
*/
extern SDLNavigationAction const SDLNavigationActionExit;
-/*
+/**
* A navigation action of stay.
*/
extern SDLNavigationAction const SDLNavigationActionStay;
-/*
+/**
* A navigation action of merge.
*/
extern SDLNavigationAction const SDLNavigationActionMerge;
-/*
+/**
* A navigation action of ferry.
*/
extern SDLNavigationAction const SDLNavigationActionFerry;
-/*
+/**SDLNavigationCapability.h
* A navigation action of car shuttle train.
*/
-extern SDLNavigationAction const SDLNavigationActionCarShuttleTrain;
+extern SDLNavigationAction const SDLNavigatiSDLNavigationCapability.honActionCarShuttleTrain;
-/*
+/**
* A navigation action of waypoint.
*/
extern SDLNavigationAction const SDLNavigationActionWaypoint;
diff --git a/SmartDeviceLink/SDLNavigationCapability.h b/SmartDeviceLink/SDLNavigationCapability.h
index 25785aad8..91fad7146 100644
--- a/SmartDeviceLink/SDLNavigationCapability.h
+++ b/SmartDeviceLink/SDLNavigationCapability.h
@@ -15,6 +15,11 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLNavigationCapability : SDLRPCStruct
+/// Convenience init with all parameters
+///
+/// @param sendLocationEnabled Whether or not the SendLocation RPC is enabled
+/// @param waypointsEnabled Whether SDLNavigationInstruction.hor not Waypoint related RPCs are enabled
+/// @return An SDLNavigationCapability object
- (instancetype)initWithSendLocation:(BOOL)sendLocationEnabled waypoints:(BOOL)waypointsEnabled;
/**