Fix documentation issues

3 files changed, 34 insertions, 0 deletions

diff --git a/SmartDeviceLink/SDLSoftButtonManager.h b/SmartDeviceLink/SDLSoftButtonManager.h
index 8a20b50f6..dfd3d7104 100644
--- a/SmartDeviceLink/SDLSoftButtonManager.h
+++ b/SmartDeviceLink/SDLSoftButtonManager.h
@@ -35,6 +35,9 @@ typedef void(^SDLSoftButtonUpdateCompletionHandler)(NSError *__nullable error);
  */
 @property (copy, nonatomic) NSArray<SDLSoftButtonObject *> *softButtonObjects;
 
+/**
+ All transitions made in-between beginUpdates and this method will occur as one RPC update.
+ */
 @property (assign, nonatomic, getter=isBatchingUpdates) BOOL batchUpdates;
 
 - (instancetype)init NS_UNAVAILABLE;
diff --git a/SmartDeviceLink/SDLSoftButtonReplaceOperation.h b/SmartDeviceLink/SDLSoftButtonReplaceOperation.h
index 42bae5792..9adb5afb4 100644
--- a/SmartDeviceLink/SDLSoftButtonReplaceOperation.h
+++ b/SmartDeviceLink/SDLSoftButtonReplaceOperation.h
@@ -18,10 +18,26 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ This class is an operation that takes a set of soft buttons and replaces the old set of soft buttons with the new set based on the capabilities available on the system. This operation will handle sending placeholder soft buttons with only text (if possible), uploading the initial state images, sending the initial state soft buttons with those images, and then uploading the other state images.
+ */
 @interface SDLSoftButtonReplaceOperation : SDLAsynchronousOperation
 
+/**
+ The primary text field on the system template. This is necessary to HAX a workaround for Sync 3.
+ */
 @property (strong, nonatomic) NSString *mainField1;
 
+/**
+ Initialize the replace operation
+
+ @param connectionManager The manager that will send the resultant RPCs
+ @param fileManager The file manager that will handle uploading any images
+ @param capabilities The capabilites of the soft buttons on the current template
+ @param softButtonObjects The soft buttons that should be sent
+ @param mainField1 The primary text field of the system template
+ @return The operation
+ */
 - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager capabilities:(SDLSoftButtonCapabilities *)capabilities softButtonObjects:(NSArray<SDLSoftButtonObject *> *)softButtonObjects mainField1:(NSString *)mainField1;
 
 @end
diff --git a/SmartDeviceLink/SDLSoftButtonTransitionOperation.h b/SmartDeviceLink/SDLSoftButtonTransitionOperation.h
index ca5a84bee..86650dc3c 100644
--- a/SmartDeviceLink/SDLSoftButtonTransitionOperation.h
+++ b/SmartDeviceLink/SDLSoftButtonTransitionOperation.h
@@ -17,10 +17,25 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ This operation handles changing a set of soft button objects when some of those objects have changed state.
+ */
 @interface SDLSoftButtonTransitionOperation : SDLAsynchronousOperation
 
+/**
+ The primary text field on the system template. This is necessary to HAX a workaround for Sync 3.
+ */
 @property (strong, nonatomic) NSString *mainField1;
 
+/**
+ Initialize the transition operation
+
+ @param connectionManager The manager that will send the resultant RPCs
+ @param capabilities The capabilites of the soft buttons on the current template
+ @param softButtonObjects The soft buttons that should be sent
+ @param mainField1 The primary text field of the system template
+ @return The transition operation
+ */
 - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager capabilities:(SDLSoftButtonCapabilities *)capabilities softButtons:(NSArray<SDLSoftButtonObject *> *)softButtons mainField1:(NSString *)mainField1;
 
 @end