Merge pull request #684 from ParsePlatform/nlutsenko.docs.configuration

Improve and fix documentation of ParseClientConfiguration.

Author: nlutsenko

Parse/ParseClientConfiguration.h

@@ -27,6 +27,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @protocol ParseMutableClientConfiguration <NSObject>
 
+///--------------------------------------
+/// @name Connecting to Parse
+///--------------------------------------
+
 /**
  The Parse.com application id to configure the SDK with.
  */
@@ -37,13 +41,21 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nullable, nonatomic, copy) NSString *clientKey;
 
+///--------------------------------------
+/// @name Enabling Local Datastore
+///--------------------------------------
+
 /**
  Whether or not to enable pinning in the SDK.
 
  The default value is `NO`.
  */
 @property (nonatomic, assign, readwrite, getter=isLocalDatastoreEnabled) BOOL localDatastoreEnabled;
 
+///--------------------------------------
+/// @name Enabling Extensions Data Sharing
+///--------------------------------------
+
 /**
  When set, enables data sharing with an application group identifier.
 
@@ -59,14 +71,18 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nullable, nonatomic, copy) NSString *containingApplicationBundleIdentifier;
 
+///--------------------------------------
+/// @name Other Properties
+///--------------------------------------
+
 /**
  The maximum number of retry attempts to make upon a failed network request.
  */
 @property (nonatomic, assign) NSUInteger networkRetryAttempts;
 
 @end
 
-/*!
+/**
  The `ParseClientConfiguration` represents the local configuration of the SDK to connect to the server with.
 
  These configurations can be stored, copied, and compared, but cannot be safely changed once the SDK is initialized.
@@ -76,6 +92,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface ParseClientConfiguration : NSObject <NSCopying>
 
+///--------------------------------------
+/// @name Connecting to Parse
+///--------------------------------------
+
 /**
  The Parse.com application id to configure the SDK with.
  */
@@ -86,13 +106,21 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nullable, nonatomic, copy, readonly) NSString *clientKey;
 
+///--------------------------------------
+/// @name Enabling Local Datastore
+///--------------------------------------
+
 /**
  Whether or not to enable pinning in the SDK.
 
  The default value is `NO`.
  */
 @property (nonatomic, assign, readonly, getter=isLocalDatastoreEnabled) BOOL localDatastoreEnabled;
 
+///--------------------------------------
+/// @name Enabling Extensions Data Sharing
+///--------------------------------------
+
 /**
  When set, enables data sharing with an application group identifier.
 
@@ -108,19 +136,27 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nullable, nonatomic, copy, readonly) NSString *containingApplicationBundleIdentifier;
 
+///--------------------------------------
+/// @name Other Properties
+///--------------------------------------
+
 /**
  The maximum number of retry attempts to make upon a failed network request.
  */
 @property (nonatomic, assign, readonly) NSUInteger networkRetryAttempts;
 
+///--------------------------------------
+/// @name Creating a Configuration
+///--------------------------------------
+
 /**
  Create a new SDK configuration object. This will create a temporarily modifiable configuration, and pass it to a block
  to be initialized.
  
  Example usage:
  
  ```
- [ParseClientConfiguration configurationWithBlock:^(id<ParseMutableClientconfiguration> configuration) {
+ [ParseClientConfiguration configurationWithBlock:^(id<ParseMutableClientConfiguration> configuration) {
      configuration.applicationId = ...;
      configuration.clientKey = ...;
      configuration.localDatastoreEnabled = ...;