Merge pull request #1311 from Microsoft/fix/enabled-comment-note

Add note to the comment
microsoft · Feb 19, 2019 · f423c0e · f423c0e
2 parents 98c6924 + 2ce2289
commit f423c0e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/AppCenter/AppCenter/MSAppCenter.h b/AppCenter/AppCenter/MSAppCenter.h
@@ -83,6 +83,7 @@
 
 /**
  * Enable or disable the SDK as a whole. In addition to AppCenter resources, it will also enable or disable all registered services.
+ * The state is persisted in the device's storage across application launches.
  *
  * @param isEnabled YES to enable, NO to disable.
  *

diff --git a/AppCenter/AppCenter/MSService.h b/AppCenter/AppCenter/MSService.h
@@ -6,20 +6,21 @@
 @protocol MSService <NSObject>
 
 /**
- *  Enable/disable this service.
+ * Enable or disable this service.
+ * The state is persisted in the device's storage across application launches.
  *
- *  @param isEnabled whether this service is enabled or not.
+ * @param isEnabled Whether this service is enabled or not.
  *
- *  @see isEnabled
+ * @see isEnabled
  */
 + (void)setEnabled:(BOOL)isEnabled;
 
 /**
- *  Is this service enabled.
+ * Indicates whether this service is enabled.
  *
- *  @return a boolean whether this service is enabled or not.
+ * @return `YES` if this service is enabled, `NO` if it is not.
  *
- *  @see setEnabled:
+ * @see setEnabled:
  */
 + (BOOL)isEnabled;
-Original file line number
+Diff line change
@@ Expand Up / @@ -83,6 +83,7 @@ @@
     /**
      * Enable or disable the SDK as a whole. In addition to AppCenter resources, it will also enable or disable all registered services.
+     * The state is persisted in the device's storage across application launches.
      *
      * @param isEnabled YES to enable, NO to disable.
      *
@@ Expand Down @@