Merge pull request #15 from ParsePlatform/nlutsenko.docs

Update all of the public documentation to new style.
parse-community · Dec 2, 2015 · 12d38f0 · 12d38f0
2 parents 00e43ae + 078a1ee
commit 12d38f0
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 104 deletions.
diff --git a/ParseTwitterUtils/Internal/Dialog/PFOAuth1FlowDialog.h b/ParseTwitterUtils/Internal/Dialog/PFOAuth1FlowDialog.h
@@ -14,7 +14,7 @@
 
 @protocol PFOAuth1FlowDialogDataSource <NSObject>
 
-/*!
+/**
  Asks if a link touched by a user should be opened in an external browser.
 
  If a user touches a link, the default behavior is to open the link in the Safari browser,
@@ -30,7 +30,7 @@
 
 typedef void (^PFOAuth1FlowDialogCompletion)(BOOL succeeded, NSURL *url, NSError *error);
 
-/*!
+/**
  To allow for greater mockability, this protocol exposes all of the methods implemented by PFOAuth1FlowDialog.
  */
 @protocol PFOAuth1FlowDialogInterface <NSObject>
@@ -41,25 +41,25 @@ typedef void (^PFOAuth1FlowDialogCompletion)(BOOL succeeded, NSURL *url, NSError
 @property (nonatomic, copy) NSDictionary *queryParameters;
 @property (nonatomic, copy) NSString *redirectURLPrefix;
 
-/*!
+/**
  The title that is shown in the header atop the view.
  */
 @property (nonatomic, copy) NSString *title;
 
 + (instancetype)dialogWithURL:(NSURL *)url queryParameters:(NSDictionary *)queryParameters;
 
-/*!
+/**
  The view will be added to the top of the current key window.
  */
 - (void)showAnimated:(BOOL)animated;
 
-/*!
+/**
  Hides the view.
  This method does not call the completion block.
  */
 - (void)dismissAnimated:(BOOL)animated;
 
-/*!
+/**
  Displays a URL in the dialog.
  */
 - (void)loadURL:(NSURL *)url queryParameters:(NSDictionary *)parameters;

diff --git a/ParseTwitterUtils/Internal/PFTwitterPrivateUtilities.h b/ParseTwitterUtils/Internal/PFTwitterPrivateUtilities.h
@@ -32,7 +32,7 @@
 
 @end
 
-/*!
+/**
  Raises an `NSInternalInconsistencyException` if the `condition` does not pass.
  Use `description` to supply the way to fix the exception.
  */

diff --git a/ParseTwitterUtils/Internal/PF_Twitter_Private.h b/ParseTwitterUtils/Internal/PF_Twitter_Private.h
@@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN
                           urlSession:(NSURLSession *)urlSession
                          dialogClass:(Class<PFOAuth1FlowDialogInterface>)dialogClass;
 
-/*!
+/**
  Obtain access to the local twitter account.
  Returns the twitter account if access is obtained. Otherwise, returns null.
  */

diff --git a/ParseTwitterUtils/PFTwitterUtils.h b/ParseTwitterUtils/PFTwitterUtils.h
@@ -17,7 +17,7 @@ NS_ASSUME_NONNULL_BEGIN
 @class BFTask PF_GENERIC(__covariant BFGenericType);
 @class PF_Twitter;
 
-/*!
+/**
  The `PFTwitterUtils` class provides utility functions for working with Twitter in a Parse application.
 
  This class is currently for iOS only.
@@ -28,15 +28,15 @@ NS_ASSUME_NONNULL_BEGIN
 /// @name Interacting With Twitter
 ///--------------------------------------
 
-/*!
- @abstract Gets the instance of the <PF_Twitter> object that Parse uses.
+/**
+ Gets the instance of the `PF_Twitter` object that Parse uses.
 
- @returns An instance of <PF_Twitter> object.
+ @return An instance of `PF_Twitter` object.
  */
 + (nullable PF_Twitter *)twitter;
 
-/*!
- @abstract Initializes the Twitter singleton.
+/**
+ Initializes the Twitter singleton.
 
  @warning You must invoke this in order to use the Twitter functionality in Parse.
 
@@ -45,75 +45,75 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (void)initializeWithConsumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret;
 
-/*!
- @abstract Whether the user has their account linked to Twitter.
+/**
+ Whether the user has their account linked to Twitter.
 
  @param user User to check for a Twitter link. The user must be logged in on this device.
 
- @returns `YES` if the user has their account linked to Twitter, otherwise `NO`.
+ @return `YES` if the user has their account linked to Twitter, otherwise `NO`.
  */
 + (BOOL)isLinkedWithUser:(nullable PFUser *)user;
 
 ///--------------------------------------
 /// @name Logging In & Creating Twitter-Linked Users
 ///--------------------------------------
 
-/*!
- @abstract *Asynchronously* logs in a user using Twitter.
+/**
+ *Asynchronously* logs in a user using Twitter.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically logs in (or creates, in the case where it is a new user) a <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically logs in (or creates, in the case where it is a new user) a `PFUser`.
 
- @returns The task, that encapsulates the work being done.
+ @return The task, that encapsulates the work being done.
  */
 + (BFTask PF_GENERIC(PFUser *)*)logInInBackground;
 
-/*!
- @abstract *Asynchronously* logs in a user using Twitter.
+/**
+ *Asynchronously* logs in a user using Twitter.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically logs in (or creates, in the case where it is a new user) <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically logs in (or creates, in the case where it is a new user) `PFUser`.
 
  @param block The block to execute.
  It should have the following argument signature: `^(PFUser *user, NSError *error)`.
  */
 + (void)logInWithBlock:(nullable PFUserResultBlock)block;
 
 /*
- @abstract *Asynchronously* Logs in a user using Twitter.
+ *Asynchronously* Logs in a user using Twitter.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically logs in (or creates, in the case where it is a new user) a <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically logs in (or creates, in the case where it is a new user) a `PFUser`.
 
  @param target Target object for the selector
  @param selector The selector that will be called when the asynchrounous request is complete.
  It should have the following signature: `(void)callbackWithUser:(PFUser *)user error:(NSError **)error`.
  */
 + (void)logInWithTarget:(nullable id)target selector:(nullable SEL)selector;
 
-/*!
- @abstract *Asynchronously* logs in a user using Twitter.
+/**
+ *Asynchronously* logs in a user using Twitter.
 
- @discussion Allows you to handle user login to Twitter, then provide authentication
- data to log in (or create, in the case where it is a new user) the <PFUser>.
+ Allows you to handle user login to Twitter, then provide authentication
+ data to log in (or create, in the case where it is a new user) the `PFUser`.
 
  @param twitterId The id of the Twitter user being linked.
  @param screenName The screen name of the Twitter user being linked.
  @param authToken The auth token for the user's session.
  @param authTokenSecret The auth token secret for the user's session.
 
- @returns The task, that encapsulates the work being done.
+ @return The task, that encapsulates the work being done.
  */
 + (BFTask PF_GENERIC(PFUser *)*)logInWithTwitterIdInBackground:(NSString *)twitterId
                                                     screenName:(NSString *)screenName
                                                      authToken:(NSString *)authToken
                                                authTokenSecret:(NSString *)authTokenSecret;
 
-/*!
- @abstract Logs in a user using Twitter.
+/**
+ Logs in a user using Twitter.
 
- @discussion Allows you to handle user login to Twitter, then provide authentication data
- to log in (or create, in the case where it is a new user) the <PFUser>.
+ Allows you to handle user login to Twitter, then provide authentication data
+ to log in (or create, in the case where it is a new user) the `PFUser`.
 
  @param twitterId The id of the Twitter user being linked
  @param screenName The screen name of the Twitter user being linked
@@ -129,10 +129,10 @@ NS_ASSUME_NONNULL_BEGIN
                      block:(nullable PFUserResultBlock)block;
 
 /*
- @abstract Logs in a user using Twitter.
+ Logs in a user using Twitter.
 
- @discussion Allows you to handle user login to Twitter, then provide authentication data
- to log in (or create, in the case where it is a new user) the <PFUser>.
+ Allows you to handle user login to Twitter, then provide authentication data
+ to log in (or create, in the case where it is a new user) the `PFUser`.
 
  @param twitterId The id of the Twitter user being linked.
  @param screenName The screen name of the Twitter user being linked.
@@ -153,35 +153,35 @@ NS_ASSUME_NONNULL_BEGIN
 /// @name Linking Users with Twitter
 ///--------------------------------------
 
-/*!
- @abstract *Asynchronously* links Twitter to an existing PFUser.
+/**
+ *Asynchronously* links Twitter to an existing PFUser.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically links the account to the <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically links the account to the `PFUser`.
 
  @param user User to link to Twitter.
 
  @deprecated Please use `[PFTwitterUtils linkUserInBackground:]` instead.
  */
 + (void)linkUser:(PFUser *)user PARSE_DEPRECATED("Please use +linkUserInBackground: instead.");
 
-/*!
- @abstract *Asynchronously* links Twitter to an existing <PFUser>.
+/**
+ *Asynchronously* links Twitter to an existing `PFUser`.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically links the account to the <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically links the account to the `PFUser`.
 
  @param user User to link to Twitter.
 
- @returns The task, that encapsulates the work being done.
+ @return The task, that encapsulates the work being done.
  */
 + (BFTask PF_GENERIC(NSNumber *)*)linkUserInBackground:(PFUser *)user;
 
-/*!
- @abstract *Asynchronously* links Twitter to an existing <PFUser>.
+/**
+ *Asynchronously* links Twitter to an existing `PFUser`.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically links the account to the <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically links the account to the `PFUser`.
 
  @param user User to link to Twitter.
  @param block The block to execute.
@@ -190,10 +190,10 @@ NS_ASSUME_NONNULL_BEGIN
 + (void)linkUser:(PFUser *)user block:(nullable PFBooleanResultBlock)block;
 
 /*
- @abstract *Asynchronously* links Twitter to an existing <PFUser>.
+ *Asynchronously* links Twitter to an existing `PFUser`.
 
- @discussion This method delegates to Twitter to authenticate the user,
- and then automatically links the account to the <PFUser>.
+ This method delegates to Twitter to authenticate the user,
+ and then automatically links the account to the `PFUser`.
 
  @param user User to link to Twitter.
  @param target Target object for the selector
@@ -202,30 +202,30 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (void)linkUser:(PFUser *)user target:(nullable id)target selector:(nullable SEL)selector;
 
-/*!
- @abstract *Asynchronously* links Twitter to an existing PFUser asynchronously.
+/**
+ *Asynchronously* links Twitter to an existing PFUser asynchronously.
 
- @discussion Allows you to handle user login to Twitter,
- then provide authentication data to link the account to the <PFUser>.
+ Allows you to handle user login to Twitter,
+ then provide authentication data to link the account to the `PFUser`.
 
  @param user User to link to Twitter.
  @param twitterId The id of the Twitter user being linked.
  @param screenName The screen name of the Twitter user being linked.
  @param authToken The auth token for the user's session.
  @param authTokenSecret The auth token secret for the user's session.
- @returns The task, that encapsulates the work being done.
+ @return The task, that encapsulates the work being done.
  */
 + (BFTask PF_GENERIC(NSNumber *)*)linkUserInBackground:(PFUser *)user
                                              twitterId:(NSString *)twitterId
                                             screenName:(NSString *)screenName
                                              authToken:(NSString *)authToken
                                        authTokenSecret:(NSString *)authTokenSecret;
 
-/*!
- @abstract *Asynchronously* links Twitter to an existing <PFUser>.
+/**
+ *Asynchronously* links Twitter to an existing `PFUser`.
 
  @discussionAllows you to handle user login to Twitter,
- then provide authentication data to link the account to the <PFUser>.
+ then provide authentication data to link the account to the `PFUser`.
 
  @param user User to link to Twitter.
  @param twitterId The id of the Twitter user being linked.
@@ -243,10 +243,10 @@ NS_ASSUME_NONNULL_BEGIN
            block:(nullable PFBooleanResultBlock)block;
 
 /*
- @abstract Links Twitter to an existing <PFUser>.
+ Links Twitter to an existing `PFUser`.
 
- @discussion This method allows you to handle user login to Twitter,
- then provide authentication data to link the account to the <PFUser>.
+ This method allows you to handle user login to Twitter,
+ then provide authentication data to link the account to the `PFUser`.
 
  @param user User to link to Twitter.
  @param twitterId The id of the Twitter user being linked.
@@ -269,36 +269,36 @@ NS_ASSUME_NONNULL_BEGIN
 /// @name Unlinking Users from Twitter
 ///--------------------------------------
 
-/*!
- @abstract *Synchronously* unlinks the <PFUser> from a Twitter account.
+/**
+ *Synchronously* unlinks the `PFUser` from a Twitter account.
 
  @param user User to unlink from Twitter.
 
- @returns Returns true if the unlink was successful.
+ @return Returns true if the unlink was successful.
  */
 + (BOOL)unlinkUser:(PFUser *)user;
 
-/*!
- @abstract *Synchronously* unlinks the PFUser from a Twitter account.
+/**
+ *Synchronously* unlinks the PFUser from a Twitter account.
 
  @param user User to unlink from Twitter.
  @param error Error object to set on error.
 
- @returns Returns `YES` if the unlink was successful, otherwise `NO`.
+ @return Returns `YES` if the unlink was successful, otherwise `NO`.
  */
 + (BOOL)unlinkUser:(PFUser *)user error:(NSError **)error;
 
-/*!
- @abstract Makes an *asynchronous* request to unlink a user from a Twitter account.
+/**
+ Makes an *asynchronous* request to unlink a user from a Twitter account.
 
  @param user User to unlink from Twitter.
 
- @returns The task, that encapsulates the work being done.
+ @return The task, that encapsulates the work being done.
  */
 + (BFTask PF_GENERIC(NSNumber *)*)unlinkUserInBackground:(PFUser *)user;
 
-/*!
- @abstract Makes an *asynchronous* request to unlink a user from a Twitter account.
+/**
+ Makes an *asynchronous* request to unlink a user from a Twitter account.
 
  @param user User to unlink from Twitter.
  @param block The block to execute.
@@ -307,7 +307,7 @@ NS_ASSUME_NONNULL_BEGIN
 + (void)unlinkUserInBackground:(PFUser *)user block:(nullable PFBooleanResultBlock)block;
 
 /*
- @abstract Makes an *asynchronous* request to unlink a user from a Twitter account.
+ Makes an *asynchronous* request to unlink a user from a Twitter account.
 
  @param user User to unlink from Twitter
  @param target Target object for the selector