Apply suggestions from code review

Co-Authored-By: Joel Fischer <joeljfischer@gmail.com>

12 files changed, 14 insertions, 23 deletions

diff --git a/SmartDeviceLink/SDLAudioStreamManager.h b/SmartDeviceLink/SDLAudioStreamManager.h
index a73128ebc..131f2df8b 100755
--- a/SmartDeviceLink/SDLAudioStreamManager.h
+++ b/SmartDeviceLink/SDLAudioStreamManager.h
@@ -21,14 +21,10 @@ extern NSString *const SDLErrorDomainAudioStreamManager;
 
 /// AudioStreamManager errors
 typedef NS_ENUM(NSInteger, SDLAudioStreamManagerError) {
-    /// SDLAudioStreamManagerError
-    ///
-    /// Not connected error
+    /// The audio stream is not currently connected
     SDLAudioStreamManagerErrorNotConnected = -1,
 
-    /// SDLAudioStreamManagerError
-    ///
-    /// No queued audio
+    /// Attempted to play but there's no audio in the queue
     SDLAudioStreamManagerErrorNoQueuedAudio = -2
 };
 
diff --git a/SmartDeviceLink/SDLFunctionID.h b/SmartDeviceLink/SDLFunctionID.h
index 9d551bd20..575d17643 100644
--- a/SmartDeviceLink/SDLFunctionID.h
+++ b/SmartDeviceLink/SDLFunctionID.h
@@ -13,14 +13,13 @@ NS_ASSUME_NONNULL_BEGIN
 /// The shared object for pulling function id information
 + (instancetype)sharedInstance;
 
-/// Gets the function name for a given function ID
+/// Gets the function name for a given SDL RPC function ID
 ///
 /// @param functionID A function ID
 /// @returns An SDLRPCFunctionName
 - (nullable SDLRPCFunctionName)functionNameForId:(UInt32)functionID;
 
-
-/// Gets the function ID from a function name
+/// Gets the function ID for a given SDL RPC function name
 ///
 /// @param functionName The RPC function name
 - (nullable NSNumber<SDLInt> *)functionIdForName:(SDLRPCFunctionName)functionName;
diff --git a/SmartDeviceLink/SDLGetSystemCapability.h b/SmartDeviceLink/SDLGetSystemCapability.h
index faaac72d3..004074ea5 100644
--- a/SmartDeviceLink/SDLGetSystemCapability.h
+++ b/SmartDeviceLink/SDLGetSystemCapability.h
@@ -14,8 +14,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- *  SDLGetWayPoints.
- *  Request for expanded information about a supported system/HMI capability
+ *  SDL RPC Request for expanded information about a supported system/HMI capability
  *
  *  @since SDL 4.5
  */
diff --git a/SmartDeviceLink/SDLGetWayPoints.h b/SmartDeviceLink/SDLGetWayPoints.h
index 087c9fa2e..331acc3a0 100644
--- a/SmartDeviceLink/SDLGetWayPoints.h
+++ b/SmartDeviceLink/SDLGetWayPoints.h
@@ -9,7 +9,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// This RPC allows you to get navigation waypoint data
 ///
-/// @since 4.1
+/// @since RPC 4.1
 @interface SDLGetWayPoints : SDLRPCRequest
 
 /// Convenience init to get waypoints.
diff --git a/SmartDeviceLink/SDLKeyboardDelegate.h b/SmartDeviceLink/SDLKeyboardDelegate.h
index a3c3925f9..5637a2a45 100644
--- a/SmartDeviceLink/SDLKeyboardDelegate.h
+++ b/SmartDeviceLink/SDLKeyboardDelegate.h
@@ -35,7 +35,7 @@ typedef void(^SDLKeyboardAutoCompleteResultsHandler)(NSArray<NSString *> *_Nulla
  */
 typedef void(^SDLKeyboardCharacterSetCompletionHandler)(NSArray<NSString *> *_Nullable updatedCharacterSet);
 
-/// A protocol with available keyboard delegate methods and properties
+/// They delegate of a keyboard popup allowing customization at runtime of the keyboard.
 @protocol SDLKeyboardDelegate <NSObject>
 
 /**
diff --git a/SmartDeviceLink/SDLLightControlCapabilities.h b/SmartDeviceLink/SDLLightControlCapabilities.h
index cdc5d7a99..13f709904 100644
--- a/SmartDeviceLink/SDLLightControlCapabilities.h
+++ b/SmartDeviceLink/SDLLightControlCapabilities.h
@@ -8,7 +8,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-
 /// Current light control capabilities.
 ///
 /// @since RPC 5.0
diff --git a/SmartDeviceLink/SDLLightState.h b/SmartDeviceLink/SDLLightState.h
index faaaad272..296fbceee 100644
--- a/SmartDeviceLink/SDLLightState.h
+++ b/SmartDeviceLink/SDLLightState.h
@@ -12,7 +12,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Current light control state
 ///
-/// @since SDL 5.0
+/// @since RPC 5.0
 @interface SDLLightState : SDLRPCStruct
 
 /**
diff --git a/SmartDeviceLink/SDLLockScreenViewController.h b/SmartDeviceLink/SDLLockScreenViewController.h
index 59fd10963..acce47b1f 100644
--- a/SmartDeviceLink/SDLLockScreenViewController.h
+++ b/SmartDeviceLink/SDLLockScreenViewController.h
@@ -10,7 +10,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// The view controller fo the lockscreen.
+/// The view controller for the lockscreen.
 @interface SDLLockScreenViewController : UIViewController
 
 /// 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.
diff --git a/SmartDeviceLink/SDLLogFilter.h b/SmartDeviceLink/SDLLogFilter.h
index 72346dcb7..9a651478b 100644
--- a/SmartDeviceLink/SDLLogFilter.h
+++ b/SmartDeviceLink/SDLLogFilter.h
@@ -20,8 +20,6 @@ NS_ASSUME_NONNULL_BEGIN
 @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;
 
 /// Initializer unavailable
diff --git a/SmartDeviceLink/SDLManager.h b/SmartDeviceLink/SDLManager.h
index 77f36ba33..3e73385d3 100644
--- a/SmartDeviceLink/SDLManager.h
+++ b/SmartDeviceLink/SDLManager.h
@@ -106,7 +106,7 @@ typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error);
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
 /**
 * Deprecated internal proxy object. This should only be accessed when the Manager is READY. This property may go to nil at any time.
-* The only reason to use this is to access the `putFileStream:withRequest:` method. All other functionality exists on managers in 4.3. This will be removed in 5.0 and the functionality replicated on `SDLFileManager`.
+* All the other functionality exists on managers in sdl_ios 4.3+.
 */
 @property (strong, nonatomic, readonly, nullable) SDLProxy *proxy;
 #pragma clang diagnostic pop
diff --git a/SmartDeviceLink/SDLRPCMessageType.h b/SmartDeviceLink/SDLRPCMessageType.h
index 95fff7224..5e01c4a4b 100644
--- a/SmartDeviceLink/SDLRPCMessageType.h
+++ b/SmartDeviceLink/SDLRPCMessageType.h
@@ -13,6 +13,6 @@ typedef NS_ENUM(Byte, SDLRPCMessageType) {
     /// A response to a request
     SDLRPCMessageTypeResponse,
 
-    /// A notification that does not have a response
+    /// A message that does not have a response
     SDLRPCMessageTypeNotification
 };
diff --git a/SmartDeviceLink/SDLVersion.h b/SmartDeviceLink/SDLVersion.h
index 52edab414..22ff79dc7 100644
--- a/SmartDeviceLink/SDLVersion.h
+++ b/SmartDeviceLink/SDLVersion.h
@@ -16,13 +16,13 @@ NS_ASSUME_NONNULL_BEGIN
 /// Specifies a major / minor / patch version number for semantic versioning purposes and comparisons
 @interface SDLVersion : NSObject <NSCopying>
 
-/// Major version
+/// Major version (e.g. X.0.0)
 @property (nonatomic, assign) NSUInteger major;
 
-/// Minor version
+/// Minor version (e.g. 0.X.0)
 @property (nonatomic, assign) NSUInteger minor;
 
-/// Patch version
+/// Patch version (e.g. 0.0.X)
 @property (nonatomic, assign) NSUInteger patch;
 
 /// A String format of the current SDLVersion