summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjustingluck93 <47197545+justingluck93@users.noreply.github.com>2019-11-07 12:57:48 -0500
committerGitHub <noreply@github.com>2019-11-07 12:57:48 -0500
commit92f913aa0580520f8556e9dab195bfe788738f6d (patch)
tree77b196280ca90338a767aef6dd3d9f8180c15386
parent0e73ef395db0174c977a186429a4f61c0db1bccd (diff)
downloadsdl_ios-92f913aa0580520f8556e9dab195bfe788738f6d.tar.gz
Apply suggestions from code review
Co-Authored-By: Joel Fischer <joeljfischer@gmail.com>
-rw-r--r--SmartDeviceLink/NSNumber+NumberType.h2
-rw-r--r--SmartDeviceLink/SDLAlertManeuver.h2
-rw-r--r--SmartDeviceLink/SDLArtwork.h4
-rw-r--r--SmartDeviceLink/SDLAudioControlCapabilities.h2
-rw-r--r--SmartDeviceLink/SDLAudioControlData.m1
-rwxr-xr-xSmartDeviceLink/SDLAudioStreamManager.h2
-rw-r--r--SmartDeviceLink/SDLChangeRegistration.h4
-rw-r--r--SmartDeviceLink/SDLChoice.h4
-rw-r--r--SmartDeviceLink/SDLConfiguration.h2
-rw-r--r--SmartDeviceLink/SDLCreateInteractionChoiceSet.h2
-rw-r--r--SmartDeviceLink/SDLDeviceInfo.h2
-rw-r--r--SmartDeviceLink/SDLEnum.h2
-rw-r--r--SmartDeviceLink/SDLFunctionID.h4
-rw-r--r--SmartDeviceLink/SDLGetWayPoints.h2
-rw-r--r--SmartDeviceLink/SDLImageResolution.h2
-rw-r--r--SmartDeviceLink/SDLKeyboardDelegate.h2
-rw-r--r--SmartDeviceLink/SDLLightControlCapabilities.h2
-rw-r--r--SmartDeviceLink/SDLLightControlData.h2
-rw-r--r--SmartDeviceLink/SDLLockScreenViewController.h2
-rw-r--r--SmartDeviceLink/SDLLogConstants.h8
-rw-r--r--SmartDeviceLink/SDLLogFileModule.h2
-rw-r--r--SmartDeviceLink/SDLLogFilter.h2
-rw-r--r--SmartDeviceLink/SDLManager.h2
-rw-r--r--SmartDeviceLink/SDLMenuCell.h2
-rw-r--r--SmartDeviceLink/SDLMenuManagerConstants.h4
-rw-r--r--SmartDeviceLink/SDLMenuParams.h4
-rw-r--r--SmartDeviceLink/SDLMetadataTags.h4
-rw-r--r--SmartDeviceLink/SDLNavigationJunction.h2
-rw-r--r--SmartDeviceLink/SDLOasisAddress.h1
-rw-r--r--SmartDeviceLink/SDLPerformAudioPassThru.h6
-rw-r--r--SmartDeviceLink/SDLProtocolConstants.h12
-rwxr-xr-xSmartDeviceLink/SDLRDSData.h1
-rw-r--r--SmartDeviceLink/SDLRPCMessageType.h6
-rw-r--r--SmartDeviceLink/SDLRPCRequest.h2
-rw-r--r--SmartDeviceLink/SDLRPCResponse.h2
-rw-r--r--SmartDeviceLink/SDLRPCStruct.h4
-rw-r--r--SmartDeviceLink/SDLReleaseInteriorVehicleDataModule.h2
-rw-r--r--SmartDeviceLink/SDLSISData.h2
-rw-r--r--SmartDeviceLink/SDLScreenManager.h4
-rw-r--r--SmartDeviceLink/SDLSendLocation.h2
-rw-r--r--SmartDeviceLink/SDLSoftButton.h6
-rw-r--r--SmartDeviceLink/SDLSoftButtonObject.h1
-rw-r--r--SmartDeviceLink/SDLSoftButtonState.h2
-rw-r--r--SmartDeviceLink/SDLSupportedSeat.h4
-rw-r--r--SmartDeviceLink/SDLTouch.h2
-rw-r--r--SmartDeviceLink/SDLTouchManager.h2
-rw-r--r--SmartDeviceLink/SDLVersion.h2
47 files changed, 65 insertions, 73 deletions
diff --git a/SmartDeviceLink/NSNumber+NumberType.h b/SmartDeviceLink/NSNumber+NumberType.h
index 669ae2e41..f373d6d99 100644
--- a/SmartDeviceLink/NSNumber+NumberType.h
+++ b/SmartDeviceLink/NSNumber+NumberType.h
@@ -32,7 +32,7 @@
@protocol SDLFloat
@end
-/// Declarations
+/// Extensions to NSNumber allowing for details on what kind of NSNumber is contained within.
@interface NSNumber (NumberType) <SDLInt, SDLUInt, SDLBool, SDLFloat>
@end
diff --git a/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink/SDLAlertManeuver.h
index 2e67467fc..3da7e63d4 100644
--- a/SmartDeviceLink/SDLAlertManeuver.h
+++ b/SmartDeviceLink/SDLAlertManeuver.h
@@ -18,7 +18,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAlertManeuver : SDLRPCRequest
-/// Convenience init to create an alert maneuver with these parameters
+/// Convenience init to create an alert maneuver with required parameters
///
/// @param ttsText The text to speak
/// @param softButtons An arry of soft buttons
diff --git a/SmartDeviceLink/SDLArtwork.h b/SmartDeviceLink/SDLArtwork.h
index 587bc1c8c..0e8bd6180 100644
--- a/SmartDeviceLink/SDLArtwork.h
+++ b/SmartDeviceLink/SDLArtwork.h
@@ -13,7 +13,7 @@
@class SDLImage;
-/// Format of the Artwork
+/// Image format of an artwork file
typedef NS_ENUM(NSUInteger, SDLArtworkImageFormat) {
/// Image format: PNG
@@ -26,7 +26,7 @@ typedef NS_ENUM(NSUInteger, SDLArtworkImageFormat) {
NS_ASSUME_NONNULL_BEGIN
/**
- A type of SDLFile image
+ An SDLFile subclass specifically designed for images
*/
@interface SDLArtwork : SDLFile
diff --git a/SmartDeviceLink/SDLAudioControlCapabilities.h b/SmartDeviceLink/SDLAudioControlCapabilities.h
index d8d381412..7c2d6bba4 100644
--- a/SmartDeviceLink/SDLAudioControlCapabilities.h
+++ b/SmartDeviceLink/SDLAudioControlCapabilities.h
@@ -7,7 +7,7 @@
NS_ASSUME_NONNULL_BEGIN
/**
- Current audio control capability. If included, the platform supports audio controls.
+ Describes a head unit's audio control capabilities.
@since RPC 5.0
*/
diff --git a/SmartDeviceLink/SDLAudioControlData.m b/SmartDeviceLink/SDLAudioControlData.m
index 0e5e86d7e..67296c9ae 100644
--- a/SmartDeviceLink/SDLAudioControlData.m
+++ b/SmartDeviceLink/SDLAudioControlData.m
@@ -15,6 +15,7 @@ NS_ASSUME_NONNULL_BEGIN
if (!self) {
return nil;
}
+
self.source = source;
self.keepContext = keepContext;
self.volume = volume;
diff --git a/SmartDeviceLink/SDLAudioStreamManager.h b/SmartDeviceLink/SDLAudioStreamManager.h
index a5fdac650..a73128ebc 100755
--- a/SmartDeviceLink/SDLAudioStreamManager.h
+++ b/SmartDeviceLink/SDLAudioStreamManager.h
@@ -16,7 +16,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Domain error for AudioStreamManager
+/// Error relates to AudioStreamManager
extern NSString *const SDLErrorDomainAudioStreamManager;
/// AudioStreamManager errors
diff --git a/SmartDeviceLink/SDLChangeRegistration.h b/SmartDeviceLink/SDLChangeRegistration.h
index 8d4f223a8..5e16d16ef 100644
--- a/SmartDeviceLink/SDLChangeRegistration.h
+++ b/SmartDeviceLink/SDLChangeRegistration.h
@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLChangeRegistration : SDLRPCRequest
/**
-Constructs a newly allocated SDLChangeRegistration object with the given parameters
+Constructs a newly allocated SDLChangeRegistration object with required parameters
@param language the name of the button
@param hmiDisplayLanguage the module where the button should be pressed
@@ -30,7 +30,7 @@ Constructs a newly allocated SDLChangeRegistration object with the given paramet
- (instancetype)initWithLanguage:(SDLLanguage)language hmiDisplayLanguage:(SDLLanguage)hmiDisplayLanguage;
/**
-Constructs a newly allocated SDLChangeRegistration object with the given parameters
+Constructs a newly allocated SDLChangeRegistration object with all parameters
@param language the language the app wants to change to
@param hmiDisplayLanguage HMI display language
diff --git a/SmartDeviceLink/SDLChoice.h b/SmartDeviceLink/SDLChoice.h
index b62539e2d..965115951 100644
--- a/SmartDeviceLink/SDLChoice.h
+++ b/SmartDeviceLink/SDLChoice.h
@@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLChoice : SDLRPCStruct
/**
-Constructs a newly allocated SDLChangeRegistration object with the given parameters
+Constructs a newly allocated SDLChangeRegistration object with the required parameters
@param choiceId the application-scoped identifier that uniquely identifies this choice
@param menuName text which appears in menu, representing this choice
@@ -27,7 +27,7 @@ Constructs a newly allocated SDLChangeRegistration object with the given paramet
- (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(nullable NSArray<NSString *> *)vrCommands;
/**
-Constructs a newly allocated SDLChangeRegistration object with the given parameters
+Constructs a newly allocated SDLChangeRegistration object with all parameters
@param choiceId the application-scoped identifier that uniquely identifies this choice
@param menuName text which appears in menu, representing this choice
diff --git a/SmartDeviceLink/SDLConfiguration.h b/SmartDeviceLink/SDLConfiguration.h
index c53a69f5a..663ca6a7d 100644
--- a/SmartDeviceLink/SDLConfiguration.h
+++ b/SmartDeviceLink/SDLConfiguration.h
@@ -17,7 +17,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Contains information about the apps configurtion, such as lifecycle, lockscreen, encryption, etc.
+/// Contains information about the app's configurtion, such as lifecycle, lockscreen, encryption, etc.
@interface SDLConfiguration : NSObject <NSCopying>
/**
diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
index 9abdf627e..da54d58e3 100644
--- a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
+++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
@@ -23,7 +23,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLCreateInteractionChoiceSet : SDLRPCRequest
-/// Convenience init for creating a choice set
+/// Convenience init for creating a choice set RPC
///
/// @param choiceId A unique ID that identifies the Choice Set
/// @param choiceSet Array of choices, which the user can select by menu or voice recognition
diff --git a/SmartDeviceLink/SDLDeviceInfo.h b/SmartDeviceLink/SDLDeviceInfo.h
index f442c6574..f30e2d598 100644
--- a/SmartDeviceLink/SDLDeviceInfo.h
+++ b/SmartDeviceLink/SDLDeviceInfo.h
@@ -10,7 +10,7 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLDeviceInfo : SDLRPCStruct
-/// Convenience init. Object will contain all information about the connected device.
+/// Convenience init. Object will contain all information about the connected device automatically.
///
/// @return An SDLDeviceInfo object
+ (instancetype)currentDevice;
diff --git a/SmartDeviceLink/SDLEnum.h b/SmartDeviceLink/SDLEnum.h
index a35c1fa4c..c62a733e5 100644
--- a/SmartDeviceLink/SDLEnum.h
+++ b/SmartDeviceLink/SDLEnum.h
@@ -10,7 +10,7 @@ NS_ASSUME_NONNULL_BEGIN
/// NSString SDLEnum typedef
typedef NSString* SDLEnum SDL_SWIFT_ENUM;
-/// Compares two enums for equivalents
+/// Extensions to NSString specifically for SDL string enums
@interface NSString (SDLEnum)
/**
diff --git a/SmartDeviceLink/SDLFunctionID.h b/SmartDeviceLink/SDLFunctionID.h
index 6596f752e..9d551bd20 100644
--- a/SmartDeviceLink/SDLFunctionID.h
+++ b/SmartDeviceLink/SDLFunctionID.h
@@ -7,10 +7,10 @@
NS_ASSUME_NONNULL_BEGIN
-/// The function IDs os each RPC
+/// A function ID for an SDL RPC
@interface SDLFunctionID : NSObject
-/// A shared instance
+/// The shared object for pulling function id information
+ (instancetype)sharedInstance;
/// Gets the function name for a given function ID
diff --git a/SmartDeviceLink/SDLGetWayPoints.h b/SmartDeviceLink/SDLGetWayPoints.h
index 8d5fd56bf..087c9fa2e 100644
--- a/SmartDeviceLink/SDLGetWayPoints.h
+++ b/SmartDeviceLink/SDLGetWayPoints.h
@@ -7,7 +7,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// This RPC allows you to get waypoint data
+/// This RPC allows you to get navigation waypoint data
///
/// @since 4.1
@interface SDLGetWayPoints : SDLRPCRequest
diff --git a/SmartDeviceLink/SDLImageResolution.h b/SmartDeviceLink/SDLImageResolution.h
index 3dc3c3413..bd9a82ae4 100644
--- a/SmartDeviceLink/SDLImageResolution.h
+++ b/SmartDeviceLink/SDLImageResolution.h
@@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
*/
@property (strong, nonatomic) NSNumber<SDLInt> *resolutionHeight;
-/// Convenience init with all parametersSDLKeyboardDelegate.h
+/// Convenience init with all parameters
///
/// @param width Resolution width
/// @param height Resolution height
diff --git a/SmartDeviceLink/SDLKeyboardDelegate.h b/SmartDeviceLink/SDLKeyboardDelegate.h
index 95d8e826f..a3c3925f9 100644
--- a/SmartDeviceLink/SDLKeyboardDelegate.h
+++ b/SmartDeviceLink/SDLKeyboardDelegate.h
@@ -38,7 +38,7 @@ typedef void(^SDLKeyboardCharacterSetCompletionHandler)(NSArray<NSString *> *_Nu
/// 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/SDLLightControlCapabilities.h b/SmartDeviceLink/SDLLightControlCapabilities.h
index 7f18ee769..cdc5d7a99 100644
--- a/SmartDeviceLink/SDLLightControlCapabilities.h
+++ b/SmartDeviceLink/SDLLightControlCapabilities.h
@@ -9,7 +9,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Current light control capabilitie. If included, the platform supports light controls.
+/// Current light control capabilities.
///
/// @since RPC 5.0
@interface SDLLightControlCapabilities : SDLRPCStruct
diff --git a/SmartDeviceLink/SDLLightControlData.h b/SmartDeviceLink/SDLLightControlData.h
index 215e869db..a76d4c727 100644
--- a/SmartDeviceLink/SDLLightControlData.h
+++ b/SmartDeviceLink/SDLLightControlData.h
@@ -9,7 +9,7 @@ NS_ASSUME_NONNULL_BEGIN
/// Data about the current light controls
///
-/// @since 5.0
+/// @since SDL 5.0
@interface SDLLightControlData : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLLockScreenViewController.h b/SmartDeviceLink/SDLLockScreenViewController.h
index 910f83a0e..59fd10963 100644
--- a/SmartDeviceLink/SDLLockScreenViewController.h
+++ b/SmartDeviceLink/SDLLockScreenViewController.h
@@ -13,7 +13,7 @@ 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.
+/// A block that can be used to close the lockscreen when the user swipes on the lockscreen. Override this in your own custom view controllers if you build a custom lock screen.
typedef void (^SwipeGestureCallbackBlock)(void);
/**
diff --git a/SmartDeviceLink/SDLLogConstants.h b/SmartDeviceLink/SDLLogConstants.h
index 12587e352..e514edffb 100644
--- a/SmartDeviceLink/SDLLogConstants.h
+++ b/SmartDeviceLink/SDLLogConstants.h
@@ -22,14 +22,10 @@ typedef BOOL (^SDLLogFilterBlock)(SDLLogModel *log);
/// An enum describing log bytes direction
typedef NS_ENUM(NSUInteger, SDLLogBytesDirection) {
- /// SDLLogBytesDirection
- ///
- /// Trasmit
+ /// Transmit from the app
SDLLogBytesDirectionTransmit,
- /// SDLLogBytesDirection
- ///
- /// Receive
+ /// Receive from the module
SDLLogBytesDirectionReceive
};
diff --git a/SmartDeviceLink/SDLLogFileModule.h b/SmartDeviceLink/SDLLogFileModule.h
index 22ff9af05..16fb3b596 100644
--- a/SmartDeviceLink/SDLLogFileModule.h
+++ b/SmartDeviceLink/SDLLogFileModule.h
@@ -13,7 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Log file module information
+/// A log file module is a collection of source code files that form a cohesive unit and that logs can all use to describe themselves. E.g. a "transport" module, or a "Screen Manager" module.
@interface SDLLogFileModule : NSObject
/**
diff --git a/SmartDeviceLink/SDLLogFilter.h b/SmartDeviceLink/SDLLogFilter.h
index 42dbd1f38..72346dcb7 100644
--- a/SmartDeviceLink/SDLLogFilter.h
+++ b/SmartDeviceLink/SDLLogFilter.h
@@ -16,7 +16,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Log filter information
+/// Represents a filter over which SDL logs should be logged
@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.
diff --git a/SmartDeviceLink/SDLManager.h b/SmartDeviceLink/SDLManager.h
index ea6dc71e8..77f36ba33 100644
--- a/SmartDeviceLink/SDLManager.h
+++ b/SmartDeviceLink/SDLManager.h
@@ -34,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN
/// @param error the error is any exists
typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error);
-/// SDLManager
+/// The top level manager object for all of SDL's interactions with the app and the head unit
@interface SDLManager : NSObject
/**
diff --git a/SmartDeviceLink/SDLMenuCell.h b/SmartDeviceLink/SDLMenuCell.h
index c91384742..d55360a8b 100644
--- a/SmartDeviceLink/SDLMenuCell.h
+++ b/SmartDeviceLink/SDLMenuCell.h
@@ -22,7 +22,7 @@ The handler to run when a menu item is selected.
*/
typedef void(^SDLMenuCellSelectionHandler)(SDLTriggerSource triggerSource);
-/// A menu cell item for the drop down menu.
+/// A menu cell item for the main menu or sub-menu.
@interface SDLMenuCell : NSObject
/**
diff --git a/SmartDeviceLink/SDLMenuManagerConstants.h b/SmartDeviceLink/SDLMenuManagerConstants.h
index 4124b96f5..5e23971e9 100644
--- a/SmartDeviceLink/SDLMenuManagerConstants.h
+++ b/SmartDeviceLink/SDLMenuManagerConstants.h
@@ -13,7 +13,6 @@
///
/// 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,
@@ -28,8 +27,7 @@ typedef NS_ENUM(NSUInteger, SDLDynamicMenuUpdatesMode) {
/// Menu cell state
///
/// Cell state that tells the menu manager what it should do with a given SDLMenuCell
-typedef NS_ENUM(NSUInteger, MenuCellState) {\
-
+typedef NS_ENUM(NSUInteger, MenuCellState) {
/// Marks the cell to be deleted
MenuCellStateDelete = 0,
diff --git a/SmartDeviceLink/SDLMenuParams.h b/SmartDeviceLink/SDLMenuParams.h
index cb64be8c2..89d807f9e 100644
--- a/SmartDeviceLink/SDLMenuParams.h
+++ b/SmartDeviceLink/SDLMenuParams.h
@@ -14,13 +14,13 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLMenuParams : SDLRPCStruct
-/// Convenience init.
+/// Convenience init with required parameters.
///
/// @param menuName The menu name
/// @return An instance of the add submenu class
- (instancetype)initWithMenuName:(NSString *)menuName;
-/// Convenience init with all parmeters.SDLMetadataTags.h
+/// Convenience init with all parameters.
///
/// @param menuName The menu name
/// @param parentId The unique ID of an existing submenu to which a command will be added
diff --git a/SmartDeviceLink/SDLMetadataTags.h b/SmartDeviceLink/SDLMetadataTags.h
index 6d707c7c2..4b875b848 100644
--- a/SmartDeviceLink/SDLMetadataTags.h
+++ b/SmartDeviceLink/SDLMetadataTags.h
@@ -11,7 +11,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// App defined metadata information
+/// Metadata for Show fields
@interface SDLMetadataTags : SDLRPCStruct
/**
@@ -19,7 +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
+/// Constructs a newly allocated SDLMetadataType with all parameters
- (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/SDLNavigationJunction.h b/SmartDeviceLink/SDLNavigationJunction.h
index 4f9974439..36be6f0db 100644
--- a/SmartDeviceLink/SDLNavigationJunction.h
+++ b/SmartDeviceLink/SDLNavigationJunction.h
@@ -48,7 +48,7 @@ extern SDLNavigationJunction const SDLNavigationJunctionJughandle;
*/
extern SDLNavigationJunction const SDLNavigationJunctionAllWayYield;
-/**SDLNavigationServiceData.h
+/**
* A junction designated for traffic turn arounds.
*/
extern SDLNavigationJunction const SDLNavigationJunctionTurnAround;
diff --git a/SmartDeviceLink/SDLOasisAddress.h b/SmartDeviceLink/SDLOasisAddress.h
index c7cab4204..ab65d1f0e 100644
--- a/SmartDeviceLink/SDLOasisAddress.h
+++ b/SmartDeviceLink/SDLOasisAddress.h
@@ -21,6 +21,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithSubThoroughfare:(nullable NSString *)subThoroughfare thoroughfare:(nullable NSString *)thoroughfare locality:(nullable NSString *)locality administrativeArea:(nullable NSString *)administrativeArea postalCode:(nullable NSString *)postalCode countryCode:(nullable NSString *)countryCode;
/// Convenience init to describe an oasis address with all parameters
+///
/// @param subThoroughfare Portion of thoroughfare (e.g. house number)
/// @param thoroughfare Hypernym for street, road etc
/// @param locality Hypernym for city/village
diff --git a/SmartDeviceLink/SDLPerformAudioPassThru.h b/SmartDeviceLink/SDLPerformAudioPassThru.h
index 14d39be7e..26ca9a21a 100644
--- a/SmartDeviceLink/SDLPerformAudioPassThru.h
+++ b/SmartDeviceLink/SDLPerformAudioPassThru.h
@@ -28,6 +28,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLPerformAudioPassThru : SDLRPCRequest
/// Convenience init to perform an audio pass thru
+///
/// @param samplingRate A samplingRate
/// @param bitsPerSample The quality the audio is recorded - 8 bit or 16 bit
/// @param audioType An audioType
@@ -35,6 +36,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithSamplingRate:(SDLSamplingRate)samplingRate bitsPerSample:(SDLBitsPerSample)bitsPerSample audioType:(SDLAudioType)audioType maxDuration:(UInt32)maxDuration;
/// Convenience init to perform an audio pass thru
+///
/// @param initialPrompt Initial prompt which will be spoken before opening the audio pass thru session by SDL
/// @param audioPassThruDisplayText1 A line of text displayed during audio capture
/// @param audioPassThruDisplayText2 A line of text displayed during audio capture
@@ -46,6 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt audioPassThruDisplayText1:(nullable NSString *)audioPassThruDisplayText1 audioPassThruDisplayText2:(nullable NSString *)audioPassThruDisplayText2 samplingRate:(SDLSamplingRate)samplingRate bitsPerSample:(SDLBitsPerSample)bitsPerSample audioType:(SDLAudioType)audioType maxDuration:(UInt32)maxDuration muteAudio:(BOOL)muteAudio;
/// Convenience init to perform an audio pass thru
+///
/// @param samplingRate A samplingRate
/// @param bitsPerSample The quality the audio is recorded - 8 bit or 16 bit
/// @param audioType An audioType
@@ -53,7 +56,8 @@ NS_ASSUME_NONNULL_BEGIN
/// @param audioDataHandler A handler that will be called whenever an onAudioPassThru notification is received.
- (instancetype)initWithSamplingRate:(SDLSamplingRate)samplingRate bitsPerSample:(SDLBitsPerSample)bitsPerSample audioType:(SDLAudioType)audioType maxDuration:(UInt32)maxDuration audioDataHandler:(nullable SDLAudioPassThruHandler)audioDataHandler;
-/// <#Description#>
+/// Convenience init for a perform audio pass thru
+///
// @param initialPrompt Initial prompt which will be spoken before opening the audio pass thru session by SDL
/// @param audioPassThruDisplayText1 A line of text displayed during audio capture
/// @param audioPassThruDisplayText2 A line of text displayed during audio capture
diff --git a/SmartDeviceLink/SDLProtocolConstants.h b/SmartDeviceLink/SDLProtocolConstants.h
index f5ee0e8ea..d4e442531 100644
--- a/SmartDeviceLink/SDLProtocolConstants.h
+++ b/SmartDeviceLink/SDLProtocolConstants.h
@@ -11,19 +11,13 @@
* The data packet's header and payload combination.
*/
typedef NS_ENUM(UInt8, SDLFrameType) {
- ///SDLFrameType
- ///
- /// An SDLFrameType: Lowest-level type of packets. They can be sent over any of the defined services. They are used for the control of the services in which they are sent.
+ /// Lowest-level type of packets. They can be sent over any of the defined services. They are used for the control of the services in which they are sent.
SDLFrameTypeControl = 0x00,
- ///SDLFrameType
- ///
- /// An SDLFrameType: Contains all the data for a particular packet in the payload. The majority of frames sent over the protocol utilize this frame type.
+ /// Contains all the data for a particular packet in the payload. The majority of frames sent over the protocol utilize this frame type.
SDLFrameTypeSingle = 0x01,
- ///SDLFrameType
- ///
- /// An SDLFrameType: The First Frame in a multiple frame payload contains information about the entire sequence of frames so that the receiving end can correctly parse all the frames and reassemble the entire payload. The payload of this frame is only eight bytes and contains information regarding the rest of the sequence.
+ /// The First Frame in a multiple frame payload contains information about the entire sequence of frames so that the receiving end can correctly parse all the frames and reassemble the entire payload. The payload of this frame is only eight bytes and contains information regarding the rest of the sequence.
SDLFrameTypeFirst = 0x02,
///SDLFrameType
diff --git a/SmartDeviceLink/SDLRDSData.h b/SmartDeviceLink/SDLRDSData.h
index 3b72e7d4c..fc5b92bf7 100755
--- a/SmartDeviceLink/SDLRDSData.h
+++ b/SmartDeviceLink/SDLRDSData.h
@@ -12,6 +12,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLRDSData : SDLRPCStruct
/// Convenience init
+///
/// @param programService Program Service Name
/// @param radioText Radio Text
/// @param clockText The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD
diff --git a/SmartDeviceLink/SDLRPCMessageType.h b/SmartDeviceLink/SDLRPCMessageType.h
index 155c39ad5..95fff7224 100644
--- a/SmartDeviceLink/SDLRPCMessageType.h
+++ b/SmartDeviceLink/SDLRPCMessageType.h
@@ -7,12 +7,12 @@
The type of RPC message
*/
typedef NS_ENUM(Byte, SDLRPCMessageType) {
- /// A request from the app to the IVI system
+ /// A request that will require a response
SDLRPCMessageTypeRequest = 0,
- /// A response from the IVI system to the app
+ /// A response to a request
SDLRPCMessageTypeResponse,
- /// A notification from the IVI system to the app
+ /// A notification that does not have a response
SDLRPCMessageTypeNotification
};
diff --git a/SmartDeviceLink/SDLRPCRequest.h b/SmartDeviceLink/SDLRPCRequest.h
index 87f394365..e171c0907 100644
--- a/SmartDeviceLink/SDLRPCRequest.h
+++ b/SmartDeviceLink/SDLRPCRequest.h
@@ -6,7 +6,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// All RPCs inherit this class
+/// Superclass of RPC requests
@interface SDLRPCRequest : SDLRPCMessage
/**
diff --git a/SmartDeviceLink/SDLRPCResponse.h b/SmartDeviceLink/SDLRPCResponse.h
index 7fc3b1e1f..4e944a05e 100644
--- a/SmartDeviceLink/SDLRPCResponse.h
+++ b/SmartDeviceLink/SDLRPCResponse.h
@@ -8,7 +8,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Basic information that all RPC responses contain
+/// Superclass of RPC responses
@interface SDLRPCResponse : SDLRPCMessage
/**
diff --git a/SmartDeviceLink/SDLRPCStruct.h b/SmartDeviceLink/SDLRPCStruct.h
index 1832f74c4..523400261 100644
--- a/SmartDeviceLink/SDLRPCStruct.h
+++ b/SmartDeviceLink/SDLRPCStruct.h
@@ -8,13 +8,13 @@
NS_ASSUME_NONNULL_BEGIN
-/// Contains information about the store
+/// Superclass of all RPC-related structs and messages
@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
+/// Declares if the RPC payload ought to be protected
@property (assign, nonatomic, getter=isPayloadProtected) BOOL payloadProtected;
/**
diff --git a/SmartDeviceLink/SDLReleaseInteriorVehicleDataModule.h b/SmartDeviceLink/SDLReleaseInteriorVehicleDataModule.h
index 894e4c7ee..10db403b9 100644
--- a/SmartDeviceLink/SDLReleaseInteriorVehicleDataModule.h
+++ b/SmartDeviceLink/SDLReleaseInteriorVehicleDataModule.h
@@ -11,7 +11,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Releases a controlled module so others can take control
+/// Releases a controlled remote control module so others can take control
///
/// @since 6.0
@interface SDLReleaseInteriorVehicleDataModule : SDLRPCRequest
diff --git a/SmartDeviceLink/SDLSISData.h b/SmartDeviceLink/SDLSISData.h
index 1ba5147b3..1d645ebb2 100644
--- a/SmartDeviceLink/SDLSISData.h
+++ b/SmartDeviceLink/SDLSISData.h
@@ -15,7 +15,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSISData : SDLRPCStruct
-/// Convenience init to
+/// Convenience init to SISData
///
/// @param stationShortName Identifies the 4-alpha-character station call sign
/// @param id A SDLStationIDNumber
diff --git a/SmartDeviceLink/SDLScreenManager.h b/SmartDeviceLink/SDLScreenManager.h
index f57ac5eec..4ffe0a28a 100644
--- a/SmartDeviceLink/SDLScreenManager.h
+++ b/SmartDeviceLink/SDLScreenManager.h
@@ -45,7 +45,7 @@ typedef void(^SDLScreenManagerUpdateCompletionHandler)(NSError *__nullable error
*/
typedef void(^SDLPreloadChoiceCompletionHandler)(NSError *__nullable error);
-/// The SDLScreenManager is a manager to control certain UI features. Use the screen manager for setting up the UI of the template, creating a menu for your users, creating softbuttons and setting textfields.
+/// The SDLScreenManager is a manager to control SDL UI features. Use the screen manager for setting up the UI of the template, creating a menu for your users, creating softbuttons, setting textfields, etc..
@interface SDLScreenManager : NSObject
#pragma mark Text and Graphics
@@ -243,7 +243,7 @@ If set to `SDLDynamicMenuUpdatesModeForceOff`, menu updates will work the legacy
#pragma mark Soft Button
-/// Retrieve a SoftButtonObject from a SoftButtonObject name.
+/// Retrieve a SoftButtonObject based on its name.
/// @param name The name of the button
- (nullable SDLSoftButtonObject *)softButtonObjectNamed:(NSString *)name;
diff --git a/SmartDeviceLink/SDLSendLocation.h b/SmartDeviceLink/SDLSendLocation.h
index 39c08a1e8..ab0d747b4 100644
--- a/SmartDeviceLink/SDLSendLocation.h
+++ b/SmartDeviceLink/SDLSendLocation.h
@@ -13,7 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Used to create a location object for navigation
+/// SendLocation is used to send a location to the navigation system for navigation
///
/// @since RPC 3.0
@interface SDLSendLocation : SDLRPCRequest
diff --git a/SmartDeviceLink/SDLSoftButton.h b/SmartDeviceLink/SDLSoftButton.h
index 9b75b20f4..8fffc6727 100644
--- a/SmartDeviceLink/SDLSoftButton.h
+++ b/SmartDeviceLink/SDLSoftButton.h
@@ -18,7 +18,7 @@ NS_ASSUME_NONNULL_BEGIN
/// Convenience init
///
-/// @param handler A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur
+/// @param handler A handler that may optionally be run when the SDLSoftButton has a corresponding notification occur
- (instancetype)initWithHandler:(nullable SDLRPCButtonNotificationHandler)handler;
/// Convenience init
@@ -29,10 +29,10 @@ NS_ASSUME_NONNULL_BEGIN
/// @param highlighted Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system
/// @param buttonId Value which is returned via OnButtonPress / OnButtonEvent
/// @param systemAction Parameter indicating whether selecting a SoftButton shall call a specific system action
-/// @param handler A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.
+/// @param handler A handler that may optionally be run when the SDLSoftButton has a corresponding notification occur.
- (instancetype)initWithType:(SDLSoftButtonType)type text:(nullable NSString *)text image:(nullable SDLImage *)image highlighted:(BOOL)highlighted buttonId:(UInt16)buttonId systemAction:(nullable SDLSystemAction)systemAction handler:(nullable SDLRPCButtonNotificationHandler)handler;
-/// A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.
+/// A handler that may optionally be run when the SDLSoftButton has a corresponding notification occur.
@property (copy, nonatomic) SDLRPCButtonNotificationHandler handler;
/**
diff --git a/SmartDeviceLink/SDLSoftButtonObject.h b/SmartDeviceLink/SDLSoftButtonObject.h
index 298ecccf8..0de2f819d 100644
--- a/SmartDeviceLink/SDLSoftButtonObject.h
+++ b/SmartDeviceLink/SDLSoftButtonObject.h
@@ -58,7 +58,6 @@ NS_ASSUME_NONNULL_BEGIN
/**
Create a single-state soft button. For example, a button that brings up a Perform Interaction menu.
-
@param name The name of the button
@param state The single state of the button
@param eventHandler The handler to be called when the button is pressed
diff --git a/SmartDeviceLink/SDLSoftButtonState.h b/SmartDeviceLink/SDLSoftButtonState.h
index 64767e1d6..687192e8c 100644
--- a/SmartDeviceLink/SDLSoftButtonState.h
+++ b/SmartDeviceLink/SDLSoftButtonState.h
@@ -15,7 +15,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// A soft button state, includes data such as text, name and artwork
+/// A soft button state including data such as text, name and artwork
@interface SDLSoftButtonState : NSObject
/**
diff --git a/SmartDeviceLink/SDLSupportedSeat.h b/SmartDeviceLink/SDLSupportedSeat.h
index c17689e4c..018e0514d 100644
--- a/SmartDeviceLink/SDLSupportedSeat.h
+++ b/SmartDeviceLink/SDLSupportedSeat.h
@@ -12,7 +12,7 @@ typedef SDLEnum SDLSupportedSeat SDL_SWIFT_ENUM __deprecated;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
/**
-* @abstract Save current seat postions and settings to seat memory.
+* Save current seat positions and settings to seat memory.
*/
extern SDLSupportedSeat const SDLSupportedSeatDriver;
#pragma clang diagnostic pop
@@ -20,7 +20,7 @@ extern SDLSupportedSeat const SDLSupportedSeatDriver;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
/**
-* @abstract Restore / apply the seat memory settings to the current seat.
+* Restore / apply the seat memory settings to the current seat.
*/
extern SDLSupportedSeat const SDLSupportedSeatFrontPassenger;
#pragma clang diagnostic pop
diff --git a/SmartDeviceLink/SDLTouch.h b/SmartDeviceLink/SDLTouch.h
index fe114be17..e001257b9 100644
--- a/SmartDeviceLink/SDLTouch.h
+++ b/SmartDeviceLink/SDLTouch.h
@@ -10,8 +10,6 @@
@class SDLTouchEvent;
-/// Enum: SDLTouchIdentifier
-///
/// Identifies finger touch
typedef enum {
/// Touch was first finger
diff --git a/SmartDeviceLink/SDLTouchManager.h b/SmartDeviceLink/SDLTouchManager.h
index d35296ef0..7b7e65a97 100644
--- a/SmartDeviceLink/SDLTouchManager.h
+++ b/SmartDeviceLink/SDLTouchManager.h
@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
/// @param type The type of touch
typedef void(^SDLTouchEventHandler)(SDLTouch *touch, SDLTouchType type);
-/// Touch Manager responsible for providing touch event notifications.
+/// Touch Manager responsible for processing touch event notifications.
@interface SDLTouchManager : NSObject
/**
diff --git a/SmartDeviceLink/SDLVersion.h b/SmartDeviceLink/SDLVersion.h
index 9b262b208..52edab414 100644
--- a/SmartDeviceLink/SDLVersion.h
+++ b/SmartDeviceLink/SDLVersion.h
@@ -13,7 +13,7 @@
NS_ASSUME_NONNULL_BEGIN
-/// Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application.
+/// Specifies a major / minor / patch version number for semantic versioning purposes and comparisons
@interface SDLVersion : NSObject <NSCopying>
/// Major version