From 23efddb2184d76f76a01667077b1883c74e4d435 Mon Sep 17 00:00:00 2001 From: Nikita Lutsenko Date: Tue, 1 Dec 2015 21:36:26 -0800 Subject: [PATCH 1/5] Replace /*! with /** for new doc generation. --- ParseUI/Classes/Cells/PFCollectionViewCell.h | 8 +-- .../Classes/Cells/PFPurchaseTableViewCell.h | 16 +++--- ParseUI/Classes/Cells/PFTableViewCell.h | 4 +- ...FActivityIndicatorCollectionReusableView.h | 2 +- .../Cells/PFActivityIndicatorTableViewCell.h | 2 +- ParseUI/Classes/Internal/PFImageCache.h | 2 +- .../Classes/Internal/Views/PFLoadingView.h | 2 +- .../Classes/LogInViewController/PFLogInView.h | 50 ++++++++--------- .../PFLogInViewController.h | 30 +++++------ .../PFLogInViewController.m | 2 +- .../PFProductTableViewController.h | 4 +- .../PFQueryCollectionViewController.h | 44 +++++++-------- .../PFQueryTableViewController.h | 54 +++++++++---------- .../SignUpViewController/PFSignUpView.h | 38 ++++++------- .../PFSignUpViewController.h | 28 +++++----- ParseUI/Classes/Views/PFImageView.h | 10 ++-- ParseUI/Classes/Views/PFTextField.h | 16 +++--- 17 files changed, 156 insertions(+), 156 deletions(-) diff --git a/ParseUI/Classes/Cells/PFCollectionViewCell.h b/ParseUI/Classes/Cells/PFCollectionViewCell.h index 13d7570..490d087 100644 --- a/ParseUI/Classes/Cells/PFCollectionViewCell.h +++ b/ParseUI/Classes/Cells/PFCollectionViewCell.h @@ -28,25 +28,25 @@ NS_ASSUME_NONNULL_BEGIN @class PFImageView; @class PFObject; -/*! +/** The `PFCollectionViewCell` class represents a collection view cell which can download and display remote images stored on Parse as well as has a default simple text label. */ @interface PFCollectionViewCell : UICollectionViewCell -/*! +/** @abstract A simple lazy-loaded label for the collection view cell. */ @property (nonatomic, strong, readonly) UILabel *textLabel; -/*! +/** @abstract The lazy-loaded imageView of the collection view cell. @see PFImageView */ @property (nonatomic, strong, readonly) PFImageView *imageView; -/*! +/** @abstract This method should update all the relevant information inside a subclass of `PFCollectionViewCell`. @discussion This method is automatically called by whenever the cell diff --git a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h index f954dda..a82af71 100644 --- a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h +++ b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h @@ -26,20 +26,20 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** An enum that represents states of the PFPurchaseTableViewCell. @see PFPurchaseTableViewCell */ typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) { - /*! Normal state of the cell. */ + /** Normal state of the cell. */ PFPurchaseTableViewCellStateNormal = 0, - /*! Downloading state of the cell. */ + /** Downloading state of the cell. */ PFPurchaseTableViewCellStateDownloading, - /*! State of the cell, when the product was downloaded. */ + /** State of the cell, when the product was downloaded. */ PFPurchaseTableViewCellStateDownloaded }; -/*! +/** `PFPurchaseTableViewCell` is a subclass that is used to show products in a . @@ -47,18 +47,18 @@ typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) { */ @interface PFPurchaseTableViewCell : PFTableViewCell -/*! +/** @abstract State of the cell. @see PFPurchaseTableViewCellState */ @property (nonatomic, assign) PFPurchaseTableViewCellState state; -/*! +/** @abstract Label where price of the product is displayed. */ @property (nullable, nonatomic, strong, readonly) UILabel *priceLabel; -/*! +/** @abstract Progress view that is shown, when the product is downloading. */ @property (nullable, nonatomic, strong, readonly) UIProgressView *progressView; diff --git a/ParseUI/Classes/Cells/PFTableViewCell.h b/ParseUI/Classes/Cells/PFTableViewCell.h index 173df06..c636d5b 100644 --- a/ParseUI/Classes/Cells/PFTableViewCell.h +++ b/ParseUI/Classes/Cells/PFTableViewCell.h @@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** The `PFTableViewCell` class represents a table view cell which can download and display remote images stored on Parse. When used in a - downloading and displaying of the remote images @@ -34,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN */ @interface PFTableViewCell : UITableViewCell -/*! +/** @abstract The imageView of the table view cell. @see PFImageView diff --git a/ParseUI/Classes/Internal/Cells/PFActivityIndicatorCollectionReusableView.h b/ParseUI/Classes/Internal/Cells/PFActivityIndicatorCollectionReusableView.h index 91f15fa..4400449 100644 --- a/ParseUI/Classes/Internal/Cells/PFActivityIndicatorCollectionReusableView.h +++ b/ParseUI/Classes/Internal/Cells/PFActivityIndicatorCollectionReusableView.h @@ -21,7 +21,7 @@ #import -/*! +/** The `PFActivityIndicatorCollectionReusableView` class represents a collection footer that has a simple text label and displays UIActivityIndicatorView if property is set to `YES`. An instance of this class is used as a default next page button inside . diff --git a/ParseUI/Classes/Internal/Cells/PFActivityIndicatorTableViewCell.h b/ParseUI/Classes/Internal/Cells/PFActivityIndicatorTableViewCell.h index fea50a7..e1cd474 100644 --- a/ParseUI/Classes/Internal/Cells/PFActivityIndicatorTableViewCell.h +++ b/ParseUI/Classes/Internal/Cells/PFActivityIndicatorTableViewCell.h @@ -23,7 +23,7 @@ #import -/*! +/** The `PFActivityIndicatorTableViewCell` class represents a table view cell that displays UIActivityIndicatorView as the accessory view. */ diff --git a/ParseUI/Classes/Internal/PFImageCache.h b/ParseUI/Classes/Internal/PFImageCache.h index 36c2337..38c184e 100644 --- a/ParseUI/Classes/Internal/PFImageCache.h +++ b/ParseUI/Classes/Internal/PFImageCache.h @@ -21,7 +21,7 @@ #import -/*! +/** A memory cache for UIImage, based on NSCache */ @interface PFImageCache : NSCache diff --git a/ParseUI/Classes/Internal/Views/PFLoadingView.h b/ParseUI/Classes/Internal/Views/PFLoadingView.h index 02b2a90..2663181 100644 --- a/ParseUI/Classes/Internal/Views/PFLoadingView.h +++ b/ParseUI/Classes/Internal/Views/PFLoadingView.h @@ -21,7 +21,7 @@ #import -/*! +/** A loading view that is used to show users that data is being loaded before any data is available. */ @interface PFLoadingView : UIView diff --git a/ParseUI/Classes/LogInViewController/PFLogInView.h b/ParseUI/Classes/LogInViewController/PFLogInView.h index 6f8feec..e39fb3d 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInView.h +++ b/ParseUI/Classes/LogInViewController/PFLogInView.h @@ -25,31 +25,31 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** `PFLogInFields` bitmask specifies the log in elements which are enabled in the view. @see PFLogInViewController @see PFLogInView */ typedef NS_OPTIONS(NSInteger, PFLogInFields) { - /*! No fields. */ + /** No fields. */ PFLogInFieldsNone = 0, - /*! Username and password fields. */ + /** Username and password fields. */ PFLogInFieldsUsernameAndPassword = 1 << 0, - /*! Forgot password button. */ + /** Forgot password button. */ PFLogInFieldsPasswordForgotten = 1 << 1, - /*! Login button. */ + /** Login button. */ PFLogInFieldsLogInButton = 1 << 2, - /*! Button to login with Facebook. */ + /** Button to login with Facebook. */ PFLogInFieldsFacebook = 1 << 3, - /*! Button to login with Twitter. */ + /** Button to login with Twitter. */ PFLogInFieldsTwitter = 1 << 4, - /*! Signup Button. */ + /** Signup Button. */ PFLogInFieldsSignUpButton = 1 << 5, - /*! Dismiss Button. */ + /** Dismiss Button. */ PFLogInFieldsDismissButton = 1 << 6, - /*! Default value. Combines Username, Password, Login, Signup, Forgot Password and Dismiss buttons. */ + /** Default value. Combines Username, Password, Login, Signup, Forgot Password and Dismiss buttons. */ PFLogInFieldsDefault = (PFLogInFieldsUsernameAndPassword | PFLogInFieldsLogInButton | PFLogInFieldsSignUpButton | @@ -59,7 +59,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { @class PFTextField; -/*! +/** The `PFLogInView` class provides a standard log in interface for authenticating a . */ @interface PFLogInView : UIScrollView @@ -68,7 +68,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /// @name Creating Log In View ///-------------------------------------- -/*! +/** @abstract Initializes the view with the specified log in elements. @param fields A bitmask specifying the log in elements which are enabled in the view @@ -79,7 +79,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { */ - (instancetype)initWithFields:(PFLogInFields)fields; -/*! +/** @abstract The view controller that will present this view. @discussion Used to lay out elements correctly when the presenting view controller has translucent elements. @@ -97,7 +97,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /// @name Configure Username Behaviour ///-------------------------------------- -/*! +/** @abstract If email should be used to log in, instead of username @discussion By default, this is set to `NO`. @@ -108,59 +108,59 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /// @name Log In Elements ///-------------------------------------- -/*! +/** @abstract The bitmask which specifies the enabled log in elements in the view. */ @property (nonatomic, assign, readonly) PFLogInFields fields; -/*! +/** @abstract The username text field. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) PFTextField *usernameField; -/*! +/** @abstract The password text field. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) PFTextField *passwordField; -/*! +/** @abstract The password forgotten button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *passwordForgottenButton; -/*! +/** @abstract The log in button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *logInButton; -/*! +/** @abstract The Facebook button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *facebookButton; -/*! +/** @abstract The Twitter button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *twitterButton; -/*! +/** @abstract The sign up button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *signUpButton; -/*! +/** @abstract It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *dismissButton; -/*! +/** @abstract The facebook/twitter login label. @deprecated This property is deprecated and will always be nil. */ @property (nullable, nonatomic, strong, readonly) UILabel *externalLogInLabel __attribute__(PARSE_UI_DEPRECATED("This property is deprecated and will always be nil.")); -/*! +/** @abstract The sign up label. @deprecated This property is deprecated and will always be nil. diff --git a/ParseUI/Classes/LogInViewController/PFLogInViewController.h b/ParseUI/Classes/LogInViewController/PFLogInViewController.h index e21a737..1002e77 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.h +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.h @@ -30,7 +30,7 @@ NS_ASSUME_NONNULL_BEGIN @class PFUser; @protocol PFLogInViewControllerDelegate; -/*! +/** The `PFLogInViewController` class presents and manages a standard authentication interface for logging in a . */ @interface PFLogInViewController : UIViewController @@ -39,7 +39,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Log In Elements ///-------------------------------------- -/*! +/** @abstract A bitmask specifying the log in elements which are enabled in the view. @see PFLogInFields @@ -47,7 +47,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nonatomic, assign) PFLogInFields fields; -/*! +/** @abstract The log in view. It contains all the enabled log in elements. @see PFLogInView @@ -58,21 +58,21 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Log In Behaviors ///-------------------------------------- -/*! +/** @abstract The delegate that responds to the control events of `PFLogInViewController`. @see PFLogInViewControllerDelegate */ @property (nullable, nonatomic, weak) id delegate; -/*! +/** @abstract The facebook permissions that Facebook log in requests for. @discussion If unspecified, the default is basic facebook permissions. */ @property (nullable, nonatomic, copy) NSArray *facebookPermissions; -/*! +/** @abstract The sign up controller if sign up is enabled. @discussion Use this to configure the sign up view, and the transition animation to the sign up view. @@ -80,7 +80,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nullable, nonatomic, strong) PFSignUpViewController *signUpController; -/*! +/** @abstract Whether to prompt for the email as username on the login view. @discussion If set to `YES`, we'll prompt for the email in the username field. @@ -95,18 +95,18 @@ NS_ASSUME_NONNULL_BEGIN /// @name Notifications ///-------------------------------------- -/*! +/** @abstract The notification is posted immediately after the log in succeeds. */ extern NSString *const PFLogInSuccessNotification; -/*! +/** @abstract The notification is posted immediately after the log in fails. @discussion If the delegate prevents the log in from starting, the notification is not sent. */ extern NSString *const PFLogInFailureNotification; -/*! +/** @abstract The notification is posted immediately after the log in is cancelled. */ extern NSString *const PFLogInCancelNotification; @@ -115,7 +115,7 @@ extern NSString *const PFLogInCancelNotification; /// @name PFLogInViewControllerDelegate ///-------------------------------------- -/*! +/** The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a should implement. All methods of this protocol are optional. */ @@ -127,7 +127,7 @@ extern NSString *const PFLogInCancelNotification; /// @name Customizing Behavior ///-------------------------------------- -/*! +/** @abstract Sent to the delegate to determine whether the log in request should be submitted to the server. @param logInController The login view controller that is requesting the data. @@ -144,7 +144,7 @@ shouldBeginLogInWithUsername:(NSString *)username /// @name Responding to Actions ///-------------------------------------- -/*! +/** @abstract Sent to the delegate when a is logged in. @param logInController The login view controller where login finished. @@ -152,7 +152,7 @@ shouldBeginLogInWithUsername:(NSString *)username */ - (void)logInViewController:(PFLogInViewController *)logInController didLogInUser:(PFUser *)user; -/*! +/** @abstract Sent to the delegate when the log in attempt fails. @discussion If you implement this method, PFLoginViewController will not automatically show its default @@ -164,7 +164,7 @@ shouldBeginLogInWithUsername:(NSString *)username - (void)logInViewController:(PFLogInViewController *)logInController didFailToLogInWithError:(nullable NSError *)error; -/*! +/** @abstract Sent to the delegate when the log in screen is cancelled. @param logInController The login view controller where login was cancelled. diff --git a/ParseUI/Classes/LogInViewController/PFLogInViewController.m b/ParseUI/Classes/LogInViewController/PFLogInViewController.m index 7b7d14f..6bf6a64 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.m +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.m @@ -35,7 +35,7 @@ NSString *const PFLogInFailureNotification = @"com.parse.ui.login.failure"; NSString *const PFLogInCancelNotification = @"com.parse.ui.login.cancel"; -/*! +/** This protocol exists so that we can weakly refer to messages to pass to PFFacebookUtils without actually taking a dependency on the symbols. */ diff --git a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h index 0cc9654..6e7457f 100644 --- a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h +++ b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h @@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** `PFProductTableViewController` displays in-app purchase products stored on Parse. In addition to setting up in-app purchases in iTunes Connect, the app developer needs to register product information on Parse, in the Product class. */ @interface PFProductTableViewController : PFQueryTableViewController -/*! +/** @abstract Initializes a product table view controller. @param style The UITableViewStyle for the table diff --git a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h index b8b7ce9..0648d8d 100644 --- a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h +++ b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h @@ -30,7 +30,7 @@ NS_ASSUME_NONNULL_BEGIN @class PFObject; @class PFQuery; -/*! +/** This class allows you to think about a one-to-one mapping between a and a `UICollectionViewCell`, rather than having to juggle index paths. @@ -47,32 +47,32 @@ NS_ASSUME_NONNULL_BEGIN */ @interface PFQueryCollectionViewController : UICollectionViewController -/*! +/** @abstract The class name of the this collection will use as a datasource. */ @property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName; -/*! +/** @abstract Whether the collection should use the default loading view. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL loadingViewEnabled; -/*! +/** @abstract Whether the collection should use the built-in pull-to-refresh feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL pullToRefreshEnabled; -/*! +/** @abstract Whether the collection should use the built-in pagination feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL paginationEnabled; -/*! +/** @abstract The number of objects to show per page. Default - `25`. */ @property (nonatomic, assign) IBInspectable NSUInteger objectsPerPage; -/*! +/** @abstract Whether the collection is actively loading new data from the server. */ @property (nonatomic, assign, getter=isLoading) BOOL loading; @@ -81,7 +81,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Creating a PFQueryCollectionViewController ///-------------------------------------- -/*! +/** @abstract Initializes a view controller with a `UICollectionViewFlowLayout` and a class name of that will be associated with this collection. @@ -91,7 +91,7 @@ NS_ASSUME_NONNULL_BEGIN */ - (instancetype)initWithClassName:(nullable NSString *)className; -/*! +/** @abstract Initializes a view controller with a class name of that will be associated with this collection. @param layout Layout for collection view to use. @@ -106,13 +106,13 @@ NS_ASSUME_NONNULL_BEGIN /// @name Responding to Events ///-------------------------------------- -/*! +/** Called when objects will be loaded from Parse. If you override this method, you must call [super objectsWillLoad] in your implementation. */ - (void)objectsWillLoad NS_REQUIRES_SUPER; -/*! +/** Called when objects have loaded from Parse. If you override this method, you must call [super objectsDidLoad:] in your implementation. @param error The Parse error from running the PFQuery, if there was any. @@ -123,12 +123,12 @@ NS_ASSUME_NONNULL_BEGIN /// @name Accessing Results ///-------------------------------------- -/*! +/** @abstract The array of instances of that is used as a data source. */ @property (nonatomic, copy, readonly) NSArray *objects; -/*! +/** @abstract Returns an object at a particular indexPath. @discussion The default impementation returns the object at `indexPath.item`. @@ -140,12 +140,12 @@ NS_ASSUME_NONNULL_BEGIN */ - (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath; -/*! +/** @abstract Removes an object at the specified index path, animated. */ - (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath; -/*! +/** @abstract Removes all objects at the specified index paths, animated. */ - (void)removeObjectsAtIndexPaths:(nullable NSArray *)indexes; @@ -154,14 +154,14 @@ NS_ASSUME_NONNULL_BEGIN /// @name Loading Data ///-------------------------------------- -/*! +/** @abstract Clears the collection view and loads the first page of objects. @returns An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects; -/*! +/** @abstract Loads the objects of the at the specified page and appends it to the objects already loaded and refreshes the collection. @@ -172,12 +172,12 @@ NS_ASSUME_NONNULL_BEGIN */ - (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear; -/*! +/** @abstract Loads the next page of objects, appends to table, and refreshes. */ - (void)loadNextPage; -/*! +/** @abstract Clears the collection view of all objects. */ - (void)clear; @@ -186,7 +186,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Querying ///-------------------------------------- -/*! +/** @abstract Override to construct your own custom to get the objects. @returns An instance of that method will use to the objects for this collection. @@ -197,7 +197,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Data Source Methods ///-------------------------------------- -/*! +/** @abstract Override this method to customize each cell given a that is loaded. @warning The cell should inherit from which is a subclass of `UICollectionViewCell`. @@ -212,7 +212,7 @@ NS_ASSUME_NONNULL_BEGIN cellForItemAtIndexPath:(NSIndexPath *)indexPath object:(nullable PFObject *)object; -/*! +/** @discussion Override this method to customize the view that allows the user to load the next page when pagination is turned on. diff --git a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h index 8bb56a3..300c59f 100644 --- a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h +++ b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h @@ -30,7 +30,7 @@ NS_ASSUME_NONNULL_BEGIN @class PFQuery; @class PFTableViewCell; -/*! +/** This class allows you to think about a one-to-one mapping between a and a `UITableViewCell`, rather than having to juggle index paths. @@ -49,7 +49,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Creating a PFQueryTableViewController ///-------------------------------------- -/*! +/** @abstract Initializes with a class name of the that will be associated with this table. @param style The UITableViewStyle for the table @@ -60,7 +60,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithStyle:(UITableViewStyle)style className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER; -/*! +/** @abstract Initializes with a class name of the PFObjects that will be associated with this table. @param className The class name of the instances of that this table will display. @@ -73,53 +73,53 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Behavior ///-------------------------------------- -/*! +/** @abstract The class name of the this table will use as a datasource. */ @property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName; -/*! +/** @abstract The key to use to display for the cell text label. @discussion This won't apply if you override */ @property (nullable, nonatomic, copy) IBInspectable NSString *textKey; -/*! +/** @abstract The key to use to display for the cell image view. @discussion This won't apply if you override */ @property (nullable, nonatomic, copy) IBInspectable NSString *imageKey; -/*! +/** @abstract The image to use as a placeholder for the cell images. @discussion This won't apply if you override */ @property (nullable, nonatomic, strong) IBInspectable UIImage *placeholderImage; -/*! +/** @abstract Whether the table should use the default loading view. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL loadingViewEnabled; -/*! +/** @abstract Whether the table should use the built-in pull-to-refresh feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL pullToRefreshEnabled; -/*! +/** @abstract Whether the table should use the built-in pagination feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL paginationEnabled; -/*! +/** @abstract The number of objects to show per page. Default - `25`. */ @property (nonatomic, assign) IBInspectable NSUInteger objectsPerPage; -/*! +/** @abstract Whether the table is actively loading new data from the server. */ @property (nonatomic, assign, getter=isLoading) BOOL loading; @@ -128,13 +128,13 @@ NS_ASSUME_NONNULL_BEGIN /// @name Responding to Events ///-------------------------------------- -/*! +/** Called when objects will loaded from Parse. If you override this method, you must call [super objectsWillLoad] in your implementation. */ - (void)objectsWillLoad; -/*! +/** Called when objects have loaded from Parse. If you override this method, you must call [super objectsDidLoad:] in your implementation. @param error The Parse error from running the PFQuery, if there was any. @@ -145,12 +145,12 @@ NS_ASSUME_NONNULL_BEGIN /// @name Accessing Results ///-------------------------------------- -/*! +/** @abstract The array of instances of that is used as a data source. */ @property (nullable, nonatomic, copy, readonly) NSArray *objects; -/*! +/** @abstract Returns an object at a particular indexPath. @discussion The default impementation returns the object at `indexPath.row`. @@ -162,39 +162,39 @@ NS_ASSUME_NONNULL_BEGIN */ - (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath; -/*! +/** @abstract Removes an object at the specified index path, animated. */ - (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath; -/*! +/** @abstract Removes an object at the specified index path, with or without animation. */ - (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath animated:(BOOL)animated; -/*! +/** @abstract Removes all objects at the specified index paths, animated. */ - (void)removeObjectsAtIndexPaths:(nullable NSArray *)indexes; -/*! +/** @abstract Removes all objects at the specified index paths, with or without animation. */ - (void)removeObjectsAtIndexPaths:(nullable NSArray *)indexes animated:(BOOL)animated; -/*! +/** @abstract Clears the table of all objects. */ - (void)clear; -/*! +/** @abstract Clears the table and loads the first page of objects. @returns An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects; -/*! +/** @abstract Loads the objects of the className at the specified page and appends it to the objects already loaded and refreshes the table. @@ -205,7 +205,7 @@ NS_ASSUME_NONNULL_BEGIN */ - (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear; -/*! +/** @abstract Loads the next page of objects, appends to table, and refreshes. */ - (void)loadNextPage; @@ -214,7 +214,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Querying ///-------------------------------------- -/*! +/** Override to construct your own custom PFQuery to get the objects. @result PFQuery that loadObjects will use to the objects for this table. */ @@ -224,7 +224,7 @@ NS_ASSUME_NONNULL_BEGIN /// @name Data Source Methods ///-------------------------------------- -/*! +/** @abstract Override this method to customize each cell given a PFObject that is loaded. @discussion If you don't override this method, it will use a default style cell and display either @@ -242,7 +242,7 @@ NS_ASSUME_NONNULL_BEGIN cellForRowAtIndexPath:(NSIndexPath *)indexPath object:(nullable PFObject *)object; -/*! +/** @discussion Override this method to customize the cell that allows the user to load the next page when pagination is turned on. diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpView.h b/ParseUI/Classes/SignUpViewController/PFSignUpView.h index db9d641..cb53358 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpView.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpView.h @@ -25,24 +25,24 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** `PFSignUpFields` bitmask specifies the sign up elements which are enabled in the view. @see PFSignUpViewController @see PFSignUpView */ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { - /*! Username and password fields. */ + /** Username and password fields. */ PFSignUpFieldsUsernameAndPassword = 0, - /*! Email field. */ + /** Email field. */ PFSignUpFieldsEmail = 1 << 0, - /*! This field can be used for something else. */ + /** This field can be used for something else. */ PFSignUpFieldsAdditional = 1 << 1, - /*! Sign Up Button */ + /** Sign Up Button */ PFSignUpFieldsSignUpButton = 1 << 2, - /*! Dismiss Button */ + /** Dismiss Button */ PFSignUpFieldsDismissButton = 1 << 3, - /*! Default value. Combines Username, Password, Email, Sign Up and Dismiss Buttons. */ + /** Default value. Combines Username, Password, Email, Sign Up and Dismiss Buttons. */ PFSignUpFieldsDefault = (PFSignUpFieldsUsernameAndPassword | PFSignUpFieldsEmail | PFSignUpFieldsSignUpButton | @@ -51,7 +51,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { @class PFTextField; -/*! +/** The `PFSignUpView` class provides a standard sign up interface for authenticating a . */ @interface PFSignUpView : UIScrollView @@ -60,7 +60,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Creating SignUp View ///-------------------------------------- -/*! +/** @abstract Initializes the view with the specified sign up elements. @param fields A bitmask specifying the sign up elements which are enabled in the view @@ -71,7 +71,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { */ - (instancetype)initWithFields:(PFSignUpFields)fields; -/*! +/** @abstract The view controller that will present this view. @discussion Used to lay out elements correctly when the presenting view controller has translucent elements. @@ -82,7 +82,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Customizing the Logo ///-------------------------------------- -/*! +/** @abstract The logo. By default, it is the Parse logo. */ @property (nullable, nonatomic, strong) UIView *logo; @@ -91,7 +91,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Configure Username Behaviour ///-------------------------------------- -/*! +/** @abstract If email should be used to log in, instead of username @discussion By default, this is set to `NO`. @@ -102,39 +102,39 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Sign Up Elements ///-------------------------------------- -/*! +/** @abstract The bitmask which specifies the enabled sign up elements in the view */ @property (nonatomic, assign, readonly) PFSignUpFields fields; -/*! +/** @abstract The username text field. */ @property (nullable, nonatomic, strong, readonly) PFTextField *usernameField; -/*! +/** @abstract The password text field. */ @property (nullable, nonatomic, strong, readonly) PFTextField *passwordField; -/*! +/** @abstract The email text field. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) PFTextField *emailField; -/*! +/** @abstract The additional text field. It is `nil` if the element is not enabled. @discussion This field is intended to be customized. */ @property (nullable, nonatomic, strong, readonly) PFTextField *additionalField; -/*! +/** @abstract The sign up button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *signUpButton; -/*! +/** @abstract The dismiss button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *dismissButton; diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h index 5e13f4c..2e81225 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h @@ -29,7 +29,7 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** The `PFSignUpViewController` class that presents and manages a standard authentication interface for signing up a . */ @@ -39,14 +39,14 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Sign Up Elements ///-------------------------------------- -/*! +/** @abstract A bitmask specifying the log in elements which are enabled in the view. @see PFSignUpFields */ @property (nonatomic, assign) PFSignUpFields fields; -/*! +/** @abstract The sign up view. It contains all the enabled log in elements. @see PFSignUpView @@ -57,19 +57,19 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Sign Up Behaviors ///-------------------------------------- -/*! +/** @abstract The delegate that responds to the control events of `PFSignUpViewController`. @see PFSignUpViewControllerDelegate */ @property (nullable, nonatomic, weak) id delegate; -/*! +/** @abstract Minimum required password length for user signups, defaults to `0`. */ @property (nonatomic, assign) NSUInteger minPasswordLength; -/*! +/** @abstract Whether to use the email as username on the attached . @discussion If set to `YES`, we'll hide the email field, prompt for the email in @@ -84,19 +84,19 @@ NS_ASSUME_NONNULL_BEGIN /// @name Notifications ///-------------------------------------- -/*! +/** @abstract The notification is posted immediately after the sign up succeeds. */ extern NSString *const PFSignUpSuccessNotification; -/*! +/** @abstract The notification is posted immediately after the sign up fails. @discussion If the delegate prevents the sign up to start, the notification is not sent. */ extern NSString *const PFSignUpFailureNotification; -/*! +/** @abstract The notification is posted immediately after the user cancels sign up. */ extern NSString *const PFSignUpCancelNotification; @@ -105,7 +105,7 @@ extern NSString *const PFSignUpCancelNotification; /// @name PFSignUpViewControllerDelegate ///-------------------------------------- -/*! +/** The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a should implement. All methods of this protocol are optional. */ @@ -117,7 +117,7 @@ extern NSString *const PFSignUpCancelNotification; /// @name Customizing Behavior ///-------------------------------------- -/*! +/** @abstract Sent to the delegate to determine whether the sign up request should be submitted to the server. @param signUpController The signup view controller that is requesting the data. @@ -131,7 +131,7 @@ extern NSString *const PFSignUpCancelNotification; /// @name Responding to Actions ///-------------------------------------- -/*! +/** @abstract Sent to the delegate when a is signed up. @param signUpController The signup view controller where signup finished. @@ -139,7 +139,7 @@ extern NSString *const PFSignUpCancelNotification; */ - (void)signUpViewController:(PFSignUpViewController *)signUpController didSignUpUser:(PFUser *)user; -/*! +/** @abstract Sent to the delegate when the sign up attempt fails. @param signUpController The signup view controller where signup failed. @@ -148,7 +148,7 @@ extern NSString *const PFSignUpCancelNotification; - (void)signUpViewController:(PFSignUpViewController *)signUpController didFailToSignUpWithError:(nullable NSError *)error; -/*! +/** @abstract Sent to the delegate when the sign up screen is cancelled. @param signUpController The signup view controller where signup was cancelled. diff --git a/ParseUI/Classes/Views/PFImageView.h b/ParseUI/Classes/Views/PFImageView.h index 67c5909..fe208fc 100644 --- a/ParseUI/Classes/Views/PFImageView.h +++ b/ParseUI/Classes/Views/PFImageView.h @@ -30,19 +30,19 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * @class BFTask; @class PFFile; -/*! +/** An image view that downloads and displays remote image stored on Parse's server. */ @interface PFImageView : UIImageView -/*! +/** @abstract The remote file on Parse's server that stores the image. @warning Note that the download does not start until is called. */ @property (nullable, nonatomic, strong) PFFile *file; -/*! +/** @abstract Initiate downloading of the remote image. @discussion Once the download completes, the remote image will be displayed. @@ -51,7 +51,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * */ - (BFTask *)loadInBackground; -/*! +/** @abstract Initiate downloading of the remote image. @discussion Once the download completes, the remote image will be displayed. @@ -60,7 +60,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * */ - (void)loadInBackground:(nullable PFImageViewImageResultBlock)completion; -/*! +/** @abstract Initiate downloading of the remote image. @discussion Once the download completes, the remote image will be displayed. diff --git a/ParseUI/Classes/Views/PFTextField.h b/ParseUI/Classes/Views/PFTextField.h index c50781e..39912ff 100644 --- a/ParseUI/Classes/Views/PFTextField.h +++ b/ParseUI/Classes/Views/PFTextField.h @@ -25,28 +25,28 @@ NS_ASSUME_NONNULL_BEGIN -/*! +/** `PFTextFieldSeparatorStyle` bitmask specifies the style of the separators, that should be used for a given `PFTextField`. @see PFTextField */ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ - /*! No separators are visible. */ + /** No separators are visible. */ PFTextFieldSeparatorStyleNone = 0, - /*! Separator on top of the text field. */ + /** Separator on top of the text field. */ PFTextFieldSeparatorStyleTop = 1 << 0, - /*! Separator at the bottom of the text field. */ + /** Separator at the bottom of the text field. */ PFTextFieldSeparatorStyleBottom = 1 << 1 }; -/*! +/** `PFTextField` class serves as a stylable subclass of `UITextField`. It includes styles that are specific to `ParseUI` framework and allows advanced customization. */ @interface PFTextField : UITextField -/*! +/** @abstract Separator style bitmask that should be applied to this textfield. @discussion Default: @@ -55,14 +55,14 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ */ @property (nonatomic, assign) PFTextFieldSeparatorStyle separatorStyle; -/*! +/** @abstract Color that should be used for the separators, if they are visible. @discussion Default: `227,227,227,1.0`. */ @property (nullable, nonatomic, strong) UIColor *separatorColor UI_APPEARANCE_SELECTOR; -/*! +/** This method is a convenience initializer that sets both `frame` and `separatorStyle` for an instance of `PFTextField.` @param frame The frame rectangle for the view, measured in points. From e7c91126502d47abde740331405e950eb5c33a13 Mon Sep 17 00:00:00 2001 From: Nikita Lutsenko Date: Tue, 1 Dec 2015 21:37:17 -0800 Subject: [PATCH 2/5] Remove abstract keyword from method documentation. --- ParseUI/Classes/Cells/PFCollectionViewCell.h | 6 +-- .../Classes/Cells/PFPurchaseTableViewCell.h | 6 +-- ParseUI/Classes/Cells/PFTableViewCell.h | 2 +- .../Classes/LogInViewController/PFLogInView.h | 28 ++++++------ .../PFLogInViewController.h | 26 +++++------ .../PFProductTableViewController.h | 2 +- .../PFQueryCollectionViewController.h | 36 +++++++-------- .../PFQueryTableViewController.h | 44 +++++++++---------- .../SignUpViewController/PFSignUpView.h | 22 +++++----- .../PFSignUpViewController.h | 24 +++++----- ParseUI/Classes/Views/PFImageView.h | 8 ++-- ParseUI/Classes/Views/PFTextField.h | 4 +- 12 files changed, 104 insertions(+), 104 deletions(-) diff --git a/ParseUI/Classes/Cells/PFCollectionViewCell.h b/ParseUI/Classes/Cells/PFCollectionViewCell.h index 490d087..ae5e5bb 100644 --- a/ParseUI/Classes/Cells/PFCollectionViewCell.h +++ b/ParseUI/Classes/Cells/PFCollectionViewCell.h @@ -35,19 +35,19 @@ NS_ASSUME_NONNULL_BEGIN @interface PFCollectionViewCell : UICollectionViewCell /** - @abstract A simple lazy-loaded label for the collection view cell. + A simple lazy-loaded label for the collection view cell. */ @property (nonatomic, strong, readonly) UILabel *textLabel; /** - @abstract The lazy-loaded imageView of the collection view cell. + The lazy-loaded imageView of the collection view cell. @see PFImageView */ @property (nonatomic, strong, readonly) PFImageView *imageView; /** - @abstract This method should update all the relevant information inside a subclass of `PFCollectionViewCell`. + This method should update all the relevant information inside a subclass of `PFCollectionViewCell`. @discussion This method is automatically called by whenever the cell should display new information. By default this method does nothing. diff --git a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h index a82af71..b82d522 100644 --- a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h +++ b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h @@ -48,18 +48,18 @@ typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) { @interface PFPurchaseTableViewCell : PFTableViewCell /** - @abstract State of the cell. + State of the cell. @see PFPurchaseTableViewCellState */ @property (nonatomic, assign) PFPurchaseTableViewCellState state; /** - @abstract Label where price of the product is displayed. + Label where price of the product is displayed. */ @property (nullable, nonatomic, strong, readonly) UILabel *priceLabel; /** - @abstract Progress view that is shown, when the product is downloading. + Progress view that is shown, when the product is downloading. */ @property (nullable, nonatomic, strong, readonly) UIProgressView *progressView; diff --git a/ParseUI/Classes/Cells/PFTableViewCell.h b/ParseUI/Classes/Cells/PFTableViewCell.h index c636d5b..9714162 100644 --- a/ParseUI/Classes/Cells/PFTableViewCell.h +++ b/ParseUI/Classes/Cells/PFTableViewCell.h @@ -35,7 +35,7 @@ NS_ASSUME_NONNULL_BEGIN @interface PFTableViewCell : UITableViewCell /** - @abstract The imageView of the table view cell. + The imageView of the table view cell. @see PFImageView */ diff --git a/ParseUI/Classes/LogInViewController/PFLogInView.h b/ParseUI/Classes/LogInViewController/PFLogInView.h index e39fb3d..be80724 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInView.h +++ b/ParseUI/Classes/LogInViewController/PFLogInView.h @@ -69,7 +69,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { ///-------------------------------------- /** - @abstract Initializes the view with the specified log in elements. + Initializes the view with the specified log in elements. @param fields A bitmask specifying the log in elements which are enabled in the view @@ -80,7 +80,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { - (instancetype)initWithFields:(PFLogInFields)fields; /** - @abstract The view controller that will present this view. + The view controller that will present this view. @discussion Used to lay out elements correctly when the presenting view controller has translucent elements. */ @@ -98,7 +98,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { ///-------------------------------------- /** - @abstract If email should be used to log in, instead of username + If email should be used to log in, instead of username @discussion By default, this is set to `NO`. */ @@ -109,59 +109,59 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { ///-------------------------------------- /** - @abstract The bitmask which specifies the enabled log in elements in the view. + The bitmask which specifies the enabled log in elements in the view. */ @property (nonatomic, assign, readonly) PFLogInFields fields; /** - @abstract The username text field. It is `nil` if the element is not enabled. + The username text field. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) PFTextField *usernameField; /** - @abstract The password text field. It is `nil` if the element is not enabled. + The password text field. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) PFTextField *passwordField; /** - @abstract The password forgotten button. It is `nil` if the element is not enabled. + The password forgotten button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *passwordForgottenButton; /** - @abstract The log in button. It is `nil` if the element is not enabled. + The log in button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *logInButton; /** - @abstract The Facebook button. It is `nil` if the element is not enabled. + The Facebook button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *facebookButton; /** - @abstract The Twitter button. It is `nil` if the element is not enabled. + The Twitter button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *twitterButton; /** - @abstract The sign up button. It is `nil` if the element is not enabled. + The sign up button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *signUpButton; /** - @abstract It is `nil` if the element is not enabled. + It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *dismissButton; /** - @abstract The facebook/twitter login label. + The facebook/twitter login label. @deprecated This property is deprecated and will always be nil. */ @property (nullable, nonatomic, strong, readonly) UILabel *externalLogInLabel __attribute__(PARSE_UI_DEPRECATED("This property is deprecated and will always be nil.")); /** - @abstract The sign up label. + The sign up label. @deprecated This property is deprecated and will always be nil. */ diff --git a/ParseUI/Classes/LogInViewController/PFLogInViewController.h b/ParseUI/Classes/LogInViewController/PFLogInViewController.h index 1002e77..dc731c5 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.h +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.h @@ -40,7 +40,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract A bitmask specifying the log in elements which are enabled in the view. + A bitmask specifying the log in elements which are enabled in the view. @see PFLogInFields */ @@ -48,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN /** - @abstract The log in view. It contains all the enabled log in elements. + The log in view. It contains all the enabled log in elements. @see PFLogInView */ @@ -59,21 +59,21 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The delegate that responds to the control events of `PFLogInViewController`. + The delegate that responds to the control events of `PFLogInViewController`. @see PFLogInViewControllerDelegate */ @property (nullable, nonatomic, weak) id delegate; /** - @abstract The facebook permissions that Facebook log in requests for. + The facebook permissions that Facebook log in requests for. @discussion If unspecified, the default is basic facebook permissions. */ @property (nullable, nonatomic, copy) NSArray *facebookPermissions; /** - @abstract The sign up controller if sign up is enabled. + The sign up controller if sign up is enabled. @discussion Use this to configure the sign up view, and the transition animation to the sign up view. The default is a sign up view with a username, a password, a dismiss button and a sign up button. @@ -81,7 +81,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, nonatomic, strong) PFSignUpViewController *signUpController; /** - @abstract Whether to prompt for the email as username on the login view. + Whether to prompt for the email as username on the login view. @discussion If set to `YES`, we'll prompt for the email in the username field. This property value propagates to the attached . @@ -96,18 +96,18 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The notification is posted immediately after the log in succeeds. + The notification is posted immediately after the log in succeeds. */ extern NSString *const PFLogInSuccessNotification; /** - @abstract The notification is posted immediately after the log in fails. + The notification is posted immediately after the log in fails. @discussion If the delegate prevents the log in from starting, the notification is not sent. */ extern NSString *const PFLogInFailureNotification; /** - @abstract The notification is posted immediately after the log in is cancelled. + The notification is posted immediately after the log in is cancelled. */ extern NSString *const PFLogInCancelNotification; @@ -128,7 +128,7 @@ extern NSString *const PFLogInCancelNotification; ///-------------------------------------- /** - @abstract Sent to the delegate to determine whether the log in request should be submitted to the server. + Sent to the delegate to determine whether the log in request should be submitted to the server. @param logInController The login view controller that is requesting the data. @param username the username the user tries to log in with. @@ -145,7 +145,7 @@ shouldBeginLogInWithUsername:(NSString *)username ///-------------------------------------- /** - @abstract Sent to the delegate when a is logged in. + Sent to the delegate when a is logged in. @param logInController The login view controller where login finished. @param user object that is a result of the login. @@ -153,7 +153,7 @@ shouldBeginLogInWithUsername:(NSString *)username - (void)logInViewController:(PFLogInViewController *)logInController didLogInUser:(PFUser *)user; /** - @abstract Sent to the delegate when the log in attempt fails. + Sent to the delegate when the log in attempt fails. @discussion If you implement this method, PFLoginViewController will not automatically show its default login failure alert view. Instead, you should show your custom alert view in your implementation. @@ -165,7 +165,7 @@ shouldBeginLogInWithUsername:(NSString *)username didFailToLogInWithError:(nullable NSError *)error; /** - @abstract Sent to the delegate when the log in screen is cancelled. + Sent to the delegate when the log in screen is cancelled. @param logInController The login view controller where login was cancelled. */ diff --git a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h index 6e7457f..02d65ef 100644 --- a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h +++ b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h @@ -34,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN @interface PFProductTableViewController : PFQueryTableViewController /** - @abstract Initializes a product table view controller. + Initializes a product table view controller. @param style The UITableViewStyle for the table diff --git a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h index 0648d8d..0f24fd6 100644 --- a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h +++ b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h @@ -48,32 +48,32 @@ NS_ASSUME_NONNULL_BEGIN @interface PFQueryCollectionViewController : UICollectionViewController /** - @abstract The class name of the this collection will use as a datasource. + The class name of the this collection will use as a datasource. */ @property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName; /** - @abstract Whether the collection should use the default loading view. Default - `YES`. + Whether the collection should use the default loading view. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL loadingViewEnabled; /** - @abstract Whether the collection should use the built-in pull-to-refresh feature. Default - `YES`. + Whether the collection should use the built-in pull-to-refresh feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL pullToRefreshEnabled; /** - @abstract Whether the collection should use the built-in pagination feature. Default - `YES`. + Whether the collection should use the built-in pagination feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL paginationEnabled; /** - @abstract The number of objects to show per page. Default - `25`. + The number of objects to show per page. Default - `25`. */ @property (nonatomic, assign) IBInspectable NSUInteger objectsPerPage; /** - @abstract Whether the collection is actively loading new data from the server. + Whether the collection is actively loading new data from the server. */ @property (nonatomic, assign, getter=isLoading) BOOL loading; @@ -82,7 +82,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract Initializes a view controller with a `UICollectionViewFlowLayout` and a class name + Initializes a view controller with a `UICollectionViewFlowLayout` and a class name of that will be associated with this collection. @param className The class name of the instances of that this table will display. @@ -92,7 +92,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithClassName:(nullable NSString *)className; /** - @abstract Initializes a view controller with a class name of that will be associated with this collection. + Initializes a view controller with a class name of that will be associated with this collection. @param layout Layout for collection view to use. @param className The class name of the instances of that this table will display. @@ -124,12 +124,12 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The array of instances of that is used as a data source. + The array of instances of that is used as a data source. */ @property (nonatomic, copy, readonly) NSArray *objects; /** - @abstract Returns an object at a particular indexPath. + Returns an object at a particular indexPath. @discussion The default impementation returns the object at `indexPath.item`. If you want to return objects in a different indexPath order, like for sections, override this method. @@ -141,12 +141,12 @@ NS_ASSUME_NONNULL_BEGIN - (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath; /** - @abstract Removes an object at the specified index path, animated. + Removes an object at the specified index path, animated. */ - (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath; /** - @abstract Removes all objects at the specified index paths, animated. + Removes all objects at the specified index paths, animated. */ - (void)removeObjectsAtIndexPaths:(nullable NSArray *)indexes; @@ -155,14 +155,14 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract Clears the collection view and loads the first page of objects. + Clears the collection view and loads the first page of objects. @returns An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects; /** - @abstract Loads the objects of the at the specified page and appends it to the + Loads the objects of the at the specified page and appends it to the objects already loaded and refreshes the collection. @param page The page of objects to load. @@ -173,12 +173,12 @@ NS_ASSUME_NONNULL_BEGIN - (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear; /** - @abstract Loads the next page of objects, appends to table, and refreshes. + Loads the next page of objects, appends to table, and refreshes. */ - (void)loadNextPage; /** - @abstract Clears the collection view of all objects. + Clears the collection view of all objects. */ - (void)clear; @@ -187,7 +187,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract Override to construct your own custom to get the objects. + Override to construct your own custom to get the objects. @returns An instance of that method will use to the objects for this collection. */ @@ -198,7 +198,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract Override this method to customize each cell given a that is loaded. + Override this method to customize each cell given a that is loaded. @warning The cell should inherit from which is a subclass of `UICollectionViewCell`. diff --git a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h index 300c59f..09bac77 100644 --- a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h +++ b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h @@ -50,7 +50,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract Initializes with a class name of the that will be associated with this table. + Initializes with a class name of the that will be associated with this table. @param style The UITableViewStyle for the table @param className The class name of the instances of that this table will display. @@ -61,7 +61,7 @@ NS_ASSUME_NONNULL_BEGIN className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER; /** - @abstract Initializes with a class name of the PFObjects that will be associated with this table. + Initializes with a class name of the PFObjects that will be associated with this table. @param className The class name of the instances of that this table will display. @@ -74,53 +74,53 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The class name of the this table will use as a datasource. + The class name of the this table will use as a datasource. */ @property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName; /** - @abstract The key to use to display for the cell text label. + The key to use to display for the cell text label. @discussion This won't apply if you override */ @property (nullable, nonatomic, copy) IBInspectable NSString *textKey; /** - @abstract The key to use to display for the cell image view. + The key to use to display for the cell image view. @discussion This won't apply if you override */ @property (nullable, nonatomic, copy) IBInspectable NSString *imageKey; /** - @abstract The image to use as a placeholder for the cell images. + The image to use as a placeholder for the cell images. @discussion This won't apply if you override */ @property (nullable, nonatomic, strong) IBInspectable UIImage *placeholderImage; /** - @abstract Whether the table should use the default loading view. Default - `YES`. + Whether the table should use the default loading view. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL loadingViewEnabled; /** - @abstract Whether the table should use the built-in pull-to-refresh feature. Default - `YES`. + Whether the table should use the built-in pull-to-refresh feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL pullToRefreshEnabled; /** - @abstract Whether the table should use the built-in pagination feature. Default - `YES`. + Whether the table should use the built-in pagination feature. Default - `YES`. */ @property (nonatomic, assign) IBInspectable BOOL paginationEnabled; /** - @abstract The number of objects to show per page. Default - `25`. + The number of objects to show per page. Default - `25`. */ @property (nonatomic, assign) IBInspectable NSUInteger objectsPerPage; /** - @abstract Whether the table is actively loading new data from the server. + Whether the table is actively loading new data from the server. */ @property (nonatomic, assign, getter=isLoading) BOOL loading; @@ -146,12 +146,12 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The array of instances of that is used as a data source. + The array of instances of that is used as a data source. */ @property (nullable, nonatomic, copy, readonly) NSArray *objects; /** - @abstract Returns an object at a particular indexPath. + Returns an object at a particular indexPath. @discussion The default impementation returns the object at `indexPath.row`. If you want to return objects in a different indexPath order, like for sections, override this method. @@ -163,39 +163,39 @@ NS_ASSUME_NONNULL_BEGIN - (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath; /** - @abstract Removes an object at the specified index path, animated. + Removes an object at the specified index path, animated. */ - (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath; /** - @abstract Removes an object at the specified index path, with or without animation. + Removes an object at the specified index path, with or without animation. */ - (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath animated:(BOOL)animated; /** - @abstract Removes all objects at the specified index paths, animated. + Removes all objects at the specified index paths, animated. */ - (void)removeObjectsAtIndexPaths:(nullable NSArray *)indexes; /** - @abstract Removes all objects at the specified index paths, with or without animation. + Removes all objects at the specified index paths, with or without animation. */ - (void)removeObjectsAtIndexPaths:(nullable NSArray *)indexes animated:(BOOL)animated; /** - @abstract Clears the table of all objects. + Clears the table of all objects. */ - (void)clear; /** - @abstract Clears the table and loads the first page of objects. + Clears the table and loads the first page of objects. @returns An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects; /** - @abstract Loads the objects of the className at the specified page and appends it to the + Loads the objects of the className at the specified page and appends it to the objects already loaded and refreshes the table. @param page The page of objects to load. @@ -206,7 +206,7 @@ NS_ASSUME_NONNULL_BEGIN - (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear; /** - @abstract Loads the next page of objects, appends to table, and refreshes. + Loads the next page of objects, appends to table, and refreshes. */ - (void)loadNextPage; @@ -225,7 +225,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract Override this method to customize each cell given a PFObject that is loaded. + Override this method to customize each cell given a PFObject that is loaded. @discussion If you don't override this method, it will use a default style cell and display either the first data key from the object, or it will display the key as specified with `textKey`, `imageKey`. diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpView.h b/ParseUI/Classes/SignUpViewController/PFSignUpView.h index cb53358..a69ea61 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpView.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpView.h @@ -61,7 +61,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { ///-------------------------------------- /** - @abstract Initializes the view with the specified sign up elements. + Initializes the view with the specified sign up elements. @param fields A bitmask specifying the sign up elements which are enabled in the view @@ -72,7 +72,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { - (instancetype)initWithFields:(PFSignUpFields)fields; /** - @abstract The view controller that will present this view. + The view controller that will present this view. @discussion Used to lay out elements correctly when the presenting view controller has translucent elements. */ @@ -83,7 +83,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { ///-------------------------------------- /** - @abstract The logo. By default, it is the Parse logo. + The logo. By default, it is the Parse logo. */ @property (nullable, nonatomic, strong) UIView *logo; @@ -92,7 +92,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { ///-------------------------------------- /** - @abstract If email should be used to log in, instead of username + If email should be used to log in, instead of username @discussion By default, this is set to `NO`. */ @@ -103,39 +103,39 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { ///-------------------------------------- /** - @abstract The bitmask which specifies the enabled sign up elements in the view + The bitmask which specifies the enabled sign up elements in the view */ @property (nonatomic, assign, readonly) PFSignUpFields fields; /** - @abstract The username text field. + The username text field. */ @property (nullable, nonatomic, strong, readonly) PFTextField *usernameField; /** - @abstract The password text field. + The password text field. */ @property (nullable, nonatomic, strong, readonly) PFTextField *passwordField; /** - @abstract The email text field. It is `nil` if the element is not enabled. + The email text field. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) PFTextField *emailField; /** - @abstract The additional text field. It is `nil` if the element is not enabled. + The additional text field. It is `nil` if the element is not enabled. @discussion This field is intended to be customized. */ @property (nullable, nonatomic, strong, readonly) PFTextField *additionalField; /** - @abstract The sign up button. It is `nil` if the element is not enabled. + The sign up button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *signUpButton; /** - @abstract The dismiss button. It is `nil` if the element is not enabled. + The dismiss button. It is `nil` if the element is not enabled. */ @property (nullable, nonatomic, strong, readonly) UIButton *dismissButton; diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h index 2e81225..dd33d2e 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h @@ -40,14 +40,14 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract A bitmask specifying the log in elements which are enabled in the view. + A bitmask specifying the log in elements which are enabled in the view. @see PFSignUpFields */ @property (nonatomic, assign) PFSignUpFields fields; /** - @abstract The sign up view. It contains all the enabled log in elements. + The sign up view. It contains all the enabled log in elements. @see PFSignUpView */ @@ -58,19 +58,19 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The delegate that responds to the control events of `PFSignUpViewController`. + The delegate that responds to the control events of `PFSignUpViewController`. @see PFSignUpViewControllerDelegate */ @property (nullable, nonatomic, weak) id delegate; /** - @abstract Minimum required password length for user signups, defaults to `0`. + Minimum required password length for user signups, defaults to `0`. */ @property (nonatomic, assign) NSUInteger minPasswordLength; /** - @abstract Whether to use the email as username on the attached . + Whether to use the email as username on the attached . @discussion If set to `YES`, we'll hide the email field, prompt for the email in the username field, and save the email into both username and email @@ -85,19 +85,19 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - @abstract The notification is posted immediately after the sign up succeeds. + The notification is posted immediately after the sign up succeeds. */ extern NSString *const PFSignUpSuccessNotification; /** - @abstract The notification is posted immediately after the sign up fails. + The notification is posted immediately after the sign up fails. @discussion If the delegate prevents the sign up to start, the notification is not sent. */ extern NSString *const PFSignUpFailureNotification; /** - @abstract The notification is posted immediately after the user cancels sign up. + The notification is posted immediately after the user cancels sign up. */ extern NSString *const PFSignUpCancelNotification; @@ -118,7 +118,7 @@ extern NSString *const PFSignUpCancelNotification; ///-------------------------------------- /** - @abstract Sent to the delegate to determine whether the sign up request should be submitted to the server. + Sent to the delegate to determine whether the sign up request should be submitted to the server. @param signUpController The signup view controller that is requesting the data. @param info An `NSDictionary` instance which contains all sign up information that the user entered. @@ -132,7 +132,7 @@ extern NSString *const PFSignUpCancelNotification; ///-------------------------------------- /** - @abstract Sent to the delegate when a is signed up. + Sent to the delegate when a is signed up. @param signUpController The signup view controller where signup finished. @param user object that is a result of the sign up. @@ -140,7 +140,7 @@ extern NSString *const PFSignUpCancelNotification; - (void)signUpViewController:(PFSignUpViewController *)signUpController didSignUpUser:(PFUser *)user; /** - @abstract Sent to the delegate when the sign up attempt fails. + Sent to the delegate when the sign up attempt fails. @param signUpController The signup view controller where signup failed. @param error `NSError` object representing the error that occured. @@ -149,7 +149,7 @@ extern NSString *const PFSignUpCancelNotification; didFailToSignUpWithError:(nullable NSError *)error; /** - @abstract Sent to the delegate when the sign up screen is cancelled. + Sent to the delegate when the sign up screen is cancelled. @param signUpController The signup view controller where signup was cancelled. */ diff --git a/ParseUI/Classes/Views/PFImageView.h b/ParseUI/Classes/Views/PFImageView.h index fe208fc..bf37bf3 100644 --- a/ParseUI/Classes/Views/PFImageView.h +++ b/ParseUI/Classes/Views/PFImageView.h @@ -36,14 +36,14 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * @interface PFImageView : UIImageView /** - @abstract The remote file on Parse's server that stores the image. + The remote file on Parse's server that stores the image. @warning Note that the download does not start until is called. */ @property (nullable, nonatomic, strong) PFFile *file; /** - @abstract Initiate downloading of the remote image. + Initiate downloading of the remote image. @discussion Once the download completes, the remote image will be displayed. @@ -52,7 +52,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * - (BFTask *)loadInBackground; /** - @abstract Initiate downloading of the remote image. + Initiate downloading of the remote image. @discussion Once the download completes, the remote image will be displayed. @@ -61,7 +61,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * - (void)loadInBackground:(nullable PFImageViewImageResultBlock)completion; /** - @abstract Initiate downloading of the remote image. + Initiate downloading of the remote image. @discussion Once the download completes, the remote image will be displayed. diff --git a/ParseUI/Classes/Views/PFTextField.h b/ParseUI/Classes/Views/PFTextField.h index 39912ff..ab71943 100644 --- a/ParseUI/Classes/Views/PFTextField.h +++ b/ParseUI/Classes/Views/PFTextField.h @@ -47,7 +47,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ @interface PFTextField : UITextField /** - @abstract Separator style bitmask that should be applied to this textfield. + Separator style bitmask that should be applied to this textfield. @discussion Default: @@ -56,7 +56,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ @property (nonatomic, assign) PFTextFieldSeparatorStyle separatorStyle; /** - @abstract Color that should be used for the separators, if they are visible. + Color that should be used for the separators, if they are visible. @discussion Default: `227,227,227,1.0`. */ From 6d65439698f91b059d5525da9192019a74e1ed0a Mon Sep 17 00:00:00 2001 From: Nikita Lutsenko Date: Tue, 1 Dec 2015 21:37:40 -0800 Subject: [PATCH 3/5] Remove discussion keyword from method documentation. --- ParseUI/Classes/Cells/PFCollectionViewCell.h | 2 +- ParseUI/Classes/LogInViewController/PFLogInView.h | 4 ++-- .../LogInViewController/PFLogInViewController.h | 10 +++++----- .../PFQueryCollectionViewController.h | 4 ++-- .../PFQueryTableViewController.h | 12 ++++++------ ParseUI/Classes/SignUpViewController/PFSignUpView.h | 6 +++--- .../SignUpViewController/PFSignUpViewController.h | 4 ++-- ParseUI/Classes/Views/PFImageView.h | 6 +++--- ParseUI/Classes/Views/PFTextField.h | 4 ++-- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/ParseUI/Classes/Cells/PFCollectionViewCell.h b/ParseUI/Classes/Cells/PFCollectionViewCell.h index ae5e5bb..19c4dda 100644 --- a/ParseUI/Classes/Cells/PFCollectionViewCell.h +++ b/ParseUI/Classes/Cells/PFCollectionViewCell.h @@ -49,7 +49,7 @@ NS_ASSUME_NONNULL_BEGIN /** This method should update all the relevant information inside a subclass of `PFCollectionViewCell`. - @discussion This method is automatically called by whenever the cell + This method is automatically called by whenever the cell should display new information. By default this method does nothing. @param object An instance of `PFObject` to update from. diff --git a/ParseUI/Classes/LogInViewController/PFLogInView.h b/ParseUI/Classes/LogInViewController/PFLogInView.h index be80724..2d0dc88 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInView.h +++ b/ParseUI/Classes/LogInViewController/PFLogInView.h @@ -82,7 +82,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /** The view controller that will present this view. - @discussion Used to lay out elements correctly when the presenting view controller has translucent elements. + Used to lay out elements correctly when the presenting view controller has translucent elements. */ @property (nullable, nonatomic, weak) UIViewController *presentingViewController; @@ -100,7 +100,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /** If email should be used to log in, instead of username - @discussion By default, this is set to `NO`. + By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; diff --git a/ParseUI/Classes/LogInViewController/PFLogInViewController.h b/ParseUI/Classes/LogInViewController/PFLogInViewController.h index dc731c5..8541581 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.h +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.h @@ -68,14 +68,14 @@ NS_ASSUME_NONNULL_BEGIN /** The facebook permissions that Facebook log in requests for. - @discussion If unspecified, the default is basic facebook permissions. + If unspecified, the default is basic facebook permissions. */ @property (nullable, nonatomic, copy) NSArray *facebookPermissions; /** The sign up controller if sign up is enabled. - @discussion Use this to configure the sign up view, and the transition animation to the sign up view. + Use this to configure the sign up view, and the transition animation to the sign up view. The default is a sign up view with a username, a password, a dismiss button and a sign up button. */ @property (nullable, nonatomic, strong) PFSignUpViewController *signUpController; @@ -83,7 +83,7 @@ NS_ASSUME_NONNULL_BEGIN /** Whether to prompt for the email as username on the login view. - @discussion If set to `YES`, we'll prompt for the email in the username field. + If set to `YES`, we'll prompt for the email in the username field. This property value propagates to the attached . By default, this is set to `NO`. */ @@ -102,7 +102,7 @@ extern NSString *const PFLogInSuccessNotification; /** The notification is posted immediately after the log in fails. - @discussion If the delegate prevents the log in from starting, the notification is not sent. + If the delegate prevents the log in from starting, the notification is not sent. */ extern NSString *const PFLogInFailureNotification; @@ -155,7 +155,7 @@ shouldBeginLogInWithUsername:(NSString *)username /** Sent to the delegate when the log in attempt fails. - @discussion If you implement this method, PFLoginViewController will not automatically show its default + If you implement this method, PFLoginViewController will not automatically show its default login failure alert view. Instead, you should show your custom alert view in your implementation. @param logInController The login view controller where login failed. diff --git a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h index 0f24fd6..892bff9 100644 --- a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h +++ b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h @@ -131,7 +131,7 @@ NS_ASSUME_NONNULL_BEGIN /** Returns an object at a particular indexPath. - @discussion The default impementation returns the object at `indexPath.item`. + The default impementation returns the object at `indexPath.item`. If you want to return objects in a different indexPath order, like for sections, override this method. @param indexPath An instance of `NSIndexPath`. @@ -213,7 +213,7 @@ NS_ASSUME_NONNULL_BEGIN object:(nullable PFObject *)object; /** - @discussion Override this method to customize the view that allows the user to load the + Override this method to customize the view that allows the user to load the next page when pagination is turned on. @param collectionView The collection view object associated with this controller. diff --git a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h index 09bac77..885479a 100644 --- a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h +++ b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h @@ -81,21 +81,21 @@ NS_ASSUME_NONNULL_BEGIN /** The key to use to display for the cell text label. - @discussion This won't apply if you override + This won't apply if you override */ @property (nullable, nonatomic, copy) IBInspectable NSString *textKey; /** The key to use to display for the cell image view. - @discussion This won't apply if you override + This won't apply if you override */ @property (nullable, nonatomic, copy) IBInspectable NSString *imageKey; /** The image to use as a placeholder for the cell images. - @discussion This won't apply if you override + This won't apply if you override */ @property (nullable, nonatomic, strong) IBInspectable UIImage *placeholderImage; @@ -153,7 +153,7 @@ NS_ASSUME_NONNULL_BEGIN /** Returns an object at a particular indexPath. - @discussion The default impementation returns the object at `indexPath.row`. + The default impementation returns the object at `indexPath.row`. If you want to return objects in a different indexPath order, like for sections, override this method. @param indexPath The indexPath. @@ -227,7 +227,7 @@ NS_ASSUME_NONNULL_BEGIN /** Override this method to customize each cell given a PFObject that is loaded. - @discussion If you don't override this method, it will use a default style cell and display either + If you don't override this method, it will use a default style cell and display either the first data key from the object, or it will display the key as specified with `textKey`, `imageKey`. @warning The cell should inherit from which is a subclass of `UITableViewCell`. @@ -243,7 +243,7 @@ NS_ASSUME_NONNULL_BEGIN object:(nullable PFObject *)object; /** - @discussion Override this method to customize the cell that allows the user to load the + Override this method to customize the cell that allows the user to load the next page when pagination is turned on. @param tableView The table view object associated with this controller. diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpView.h b/ParseUI/Classes/SignUpViewController/PFSignUpView.h index a69ea61..a50fb4b 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpView.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpView.h @@ -74,7 +74,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /** The view controller that will present this view. - @discussion Used to lay out elements correctly when the presenting view controller has translucent elements. + Used to lay out elements correctly when the presenting view controller has translucent elements. */ @property (nullable, nonatomic, weak) UIViewController *presentingViewController; @@ -94,7 +94,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /** If email should be used to log in, instead of username - @discussion By default, this is set to `NO`. + By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -125,7 +125,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /** The additional text field. It is `nil` if the element is not enabled. - @discussion This field is intended to be customized. + This field is intended to be customized. */ @property (nullable, nonatomic, strong, readonly) PFTextField *additionalField; diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h index dd33d2e..7f455e1 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h @@ -72,7 +72,7 @@ NS_ASSUME_NONNULL_BEGIN /** Whether to use the email as username on the attached . - @discussion If set to `YES`, we'll hide the email field, prompt for the email in + If set to `YES`, we'll hide the email field, prompt for the email in the username field, and save the email into both username and email fields on the new object. By default, this is set to `NO`. */ @@ -92,7 +92,7 @@ extern NSString *const PFSignUpSuccessNotification; /** The notification is posted immediately after the sign up fails. - @discussion If the delegate prevents the sign up to start, the notification is not sent. + If the delegate prevents the sign up to start, the notification is not sent. */ extern NSString *const PFSignUpFailureNotification; diff --git a/ParseUI/Classes/Views/PFImageView.h b/ParseUI/Classes/Views/PFImageView.h index bf37bf3..f03d526 100644 --- a/ParseUI/Classes/Views/PFImageView.h +++ b/ParseUI/Classes/Views/PFImageView.h @@ -45,7 +45,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * /** Initiate downloading of the remote image. - @discussion Once the download completes, the remote image will be displayed. + Once the download completes, the remote image will be displayed. @returns The task, that encapsulates the work being done. */ @@ -54,7 +54,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * /** Initiate downloading of the remote image. - @discussion Once the download completes, the remote image will be displayed. + Once the download completes, the remote image will be displayed. @param completion the completion block. */ @@ -63,7 +63,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * /** Initiate downloading of the remote image. - @discussion Once the download completes, the remote image will be displayed. + Once the download completes, the remote image will be displayed. @param completion the completion block. @param progressBlock called with the download progress as the image is being downloaded. diff --git a/ParseUI/Classes/Views/PFTextField.h b/ParseUI/Classes/Views/PFTextField.h index ab71943..f77e8dc 100644 --- a/ParseUI/Classes/Views/PFTextField.h +++ b/ParseUI/Classes/Views/PFTextField.h @@ -49,7 +49,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ /** Separator style bitmask that should be applied to this textfield. - @discussion Default: + Default: @see PFTextFieldSeparatorStyle */ @@ -58,7 +58,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ /** Color that should be used for the separators, if they are visible. - @discussion Default: `227,227,227,1.0`. + Default: `227,227,227,1.0`. */ @property (nullable, nonatomic, strong) UIColor *separatorColor UI_APPEARANCE_SELECTOR; From da4baf9a9e676182ec8e9cba257f26968329398d Mon Sep 17 00:00:00 2001 From: Nikita Lutsenko Date: Tue, 1 Dec 2015 21:44:11 -0800 Subject: [PATCH 4/5] Replace returns with return keyword for method documentation. --- .../Classes/LogInViewController/PFLogInView.h | 2 +- .../LogInViewController/PFLogInViewController.h | 2 +- .../PFProductTableViewController.h | 2 +- .../PFQueryCollectionViewController.h | 16 ++++++++-------- .../PFQueryTableViewController.h | 14 +++++++------- .../Classes/SignUpViewController/PFSignUpView.h | 2 +- .../PFSignUpViewController.h | 2 +- ParseUI/Classes/Views/PFImageView.h | 2 +- 8 files changed, 21 insertions(+), 21 deletions(-) diff --git a/ParseUI/Classes/LogInViewController/PFLogInView.h b/ParseUI/Classes/LogInViewController/PFLogInView.h index 2d0dc88..cd4ad25 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInView.h +++ b/ParseUI/Classes/LogInViewController/PFLogInView.h @@ -73,7 +73,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { @param fields A bitmask specifying the log in elements which are enabled in the view - @returns An initialized `PFLogInView` object or `nil` if the object couldn't be created. + @return An initialized `PFLogInView` object or `nil` if the object couldn't be created. @see PFLogInFields */ diff --git a/ParseUI/Classes/LogInViewController/PFLogInViewController.h b/ParseUI/Classes/LogInViewController/PFLogInViewController.h index 8541581..d31ec32 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.h +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.h @@ -134,7 +134,7 @@ extern NSString *const PFLogInCancelNotification; @param username the username the user tries to log in with. @param password the password the user tries to log in with. - @returns A `BOOL` indicating whether the log in should proceed. + @return A `BOOL` indicating whether the log in should proceed. */ - (BOOL)logInViewController:(PFLogInViewController *)logInController shouldBeginLogInWithUsername:(NSString *)username diff --git a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h index 02d65ef..6ee0849 100644 --- a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h +++ b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h @@ -38,7 +38,7 @@ NS_ASSUME_NONNULL_BEGIN @param style The UITableViewStyle for the table - @returns An initialized `PFProductTableViewController` object or `nil` if the object couldn't be created. + @return An initialized `PFProductTableViewController` object or `nil` if the object couldn't be created. */ - (instancetype)initWithStyle:(UITableViewStyle)style NS_DESIGNATED_INITIALIZER; diff --git a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h index 892bff9..74e1a19 100644 --- a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h +++ b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h @@ -87,7 +87,7 @@ NS_ASSUME_NONNULL_BEGIN @param className The class name of the instances of that this table will display. - @returns An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created. + @return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created. */ - (instancetype)initWithClassName:(nullable NSString *)className; @@ -97,7 +97,7 @@ NS_ASSUME_NONNULL_BEGIN @param layout Layout for collection view to use. @param className The class name of the instances of that this table will display. - @returns An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created. + @return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created. */ - (instancetype)initWithCollectionViewLayout:(UICollectionViewLayout *)layout className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER; @@ -136,7 +136,7 @@ NS_ASSUME_NONNULL_BEGIN @param indexPath An instance of `NSIndexPath`. - @returns The object at the specified indexPath. + @return The object at the specified indexPath. */ - (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath; @@ -157,7 +157,7 @@ NS_ASSUME_NONNULL_BEGIN /** Clears the collection view and loads the first page of objects. - @returns An awaitable task that completes when the reload succeeds + @return An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects; @@ -168,7 +168,7 @@ NS_ASSUME_NONNULL_BEGIN @param page The page of objects to load. @param clear Whether to clear the collection view after receiving the objects. - @returns An awaitable task that completes when the reload succeeds + @return An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear; @@ -189,7 +189,7 @@ NS_ASSUME_NONNULL_BEGIN /** Override to construct your own custom to get the objects. - @returns An instance of that method will use to the objects for this collection. + @return An instance of `PFQuery` that `-loadObjects` method will use to the objects for this collection. */ - (PFQuery *)queryForCollection; @@ -206,7 +206,7 @@ NS_ASSUME_NONNULL_BEGIN @param indexPath The indexPath of the cell. @param object The that is associated with the cell. - @returns The cell that represents this object. + @return The cell that represents this object. */ - (nullable PFCollectionViewCell *)collectionView:(UICollectionView *)collectionView cellForItemAtIndexPath:(NSIndexPath *)indexPath @@ -218,7 +218,7 @@ NS_ASSUME_NONNULL_BEGIN @param collectionView The collection view object associated with this controller. - @returns The view that allows the user to paginate. + @return The view that allows the user to paginate. */ - (nullable UICollectionReusableView *)collectionViewReusableViewForNextPageAction:(UICollectionView *)collectionView; diff --git a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h index 885479a..9205759 100644 --- a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h +++ b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h @@ -55,7 +55,7 @@ NS_ASSUME_NONNULL_BEGIN @param style The UITableViewStyle for the table @param className The class name of the instances of that this table will display. - @returns An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created. + @return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created. */ - (instancetype)initWithStyle:(UITableViewStyle)style className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER; @@ -65,7 +65,7 @@ NS_ASSUME_NONNULL_BEGIN @param className The class name of the instances of that this table will display. - @returns An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created. + @return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created. */ - (instancetype)initWithClassName:(nullable NSString *)className; @@ -158,7 +158,7 @@ NS_ASSUME_NONNULL_BEGIN @param indexPath The indexPath. - @returns The object at the specified index + @return The object at the specified index */ - (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath; @@ -190,7 +190,7 @@ NS_ASSUME_NONNULL_BEGIN /** Clears the table and loads the first page of objects. - @returns An awaitable task that completes when the reload succeeds + @return An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects; @@ -201,7 +201,7 @@ NS_ASSUME_NONNULL_BEGIN @param page The page of objects to load. @param clear Whether to clear the table after receiving the objects - @returns An awaitable task that completes when the reload succeeds + @return An awaitable task that completes when the reload succeeds */ - (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear; @@ -236,7 +236,7 @@ NS_ASSUME_NONNULL_BEGIN @param indexPath The indexPath of the cell. @param object The PFObject that is associated with the cell. - @returns The cell that represents this object. + @return The cell that represents this object. */ - (nullable PFTableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath @@ -249,7 +249,7 @@ NS_ASSUME_NONNULL_BEGIN @param tableView The table view object associated with this controller. @param indexPath The indexPath of the cell. - @returns The cell that allows the user to paginate. + @return The cell that allows the user to paginate. */ - (nullable PFTableViewCell *)tableView:(UITableView *)tableView cellForNextPageAtIndexPath:(NSIndexPath *)indexPath; diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpView.h b/ParseUI/Classes/SignUpViewController/PFSignUpView.h index a50fb4b..891472a 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpView.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpView.h @@ -65,7 +65,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { @param fields A bitmask specifying the sign up elements which are enabled in the view - @returns An initialized `PFSignUpView` object or `nil` if the object couldn't be created. + @return An initialized `PFSignUpView` object or `nil` if the object couldn't be created. @see PFSignUpFields */ diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h index 7f455e1..0b34d83 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h @@ -123,7 +123,7 @@ extern NSString *const PFSignUpCancelNotification; @param signUpController The signup view controller that is requesting the data. @param info An `NSDictionary` instance which contains all sign up information that the user entered. - @returns A `BOOL` indicating whether the sign up should proceed. + @return A `BOOL` indicating whether the sign up should proceed. */ - (BOOL)signUpViewController:(PFSignUpViewController *)signUpController shouldBeginSignUp:(NSDictionary *)info; diff --git a/ParseUI/Classes/Views/PFImageView.h b/ParseUI/Classes/Views/PFImageView.h index f03d526..19f58c9 100644 --- a/ParseUI/Classes/Views/PFImageView.h +++ b/ParseUI/Classes/Views/PFImageView.h @@ -47,7 +47,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * Once the download completes, the remote image will be displayed. - @returns The task, that encapsulates the work being done. + @return The task, that encapsulates the work being done. */ - (BFTask *)loadInBackground; From d4ecd79f9497c5589592475dbfd30d46c742f5b4 Mon Sep 17 00:00:00 2001 From: Nikita Lutsenko Date: Tue, 1 Dec 2015 21:43:44 -0800 Subject: [PATCH 5/5] Update style of cross link annotations in all of the documentation. --- ParseUI/Classes/Cells/PFCollectionViewCell.h | 2 +- .../Classes/Cells/PFPurchaseTableViewCell.h | 12 ++++----- ParseUI/Classes/Cells/PFTableViewCell.h | 6 ++--- .../Classes/LogInViewController/PFLogInView.h | 2 +- .../PFLogInViewController.h | 10 +++---- .../PFQueryCollectionViewController.h | 26 +++++++++---------- .../PFQueryTableViewController.h | 20 +++++++------- .../SignUpViewController/PFSignUpView.h | 2 +- .../PFSignUpViewController.h | 12 ++++----- ParseUI/Classes/Views/PFImageView.h | 2 +- ParseUI/Classes/Views/PFTextField.h | 2 +- 11 files changed, 48 insertions(+), 48 deletions(-) diff --git a/ParseUI/Classes/Cells/PFCollectionViewCell.h b/ParseUI/Classes/Cells/PFCollectionViewCell.h index 19c4dda..9abb31e 100644 --- a/ParseUI/Classes/Cells/PFCollectionViewCell.h +++ b/ParseUI/Classes/Cells/PFCollectionViewCell.h @@ -49,7 +49,7 @@ NS_ASSUME_NONNULL_BEGIN /** This method should update all the relevant information inside a subclass of `PFCollectionViewCell`. - This method is automatically called by whenever the cell + This method is automatically called by `PFQueryCollectionViewController` whenever the cell should display new information. By default this method does nothing. @param object An instance of `PFObject` to update from. diff --git a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h index b82d522..88e0e85 100644 --- a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h +++ b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h @@ -27,8 +27,8 @@ NS_ASSUME_NONNULL_BEGIN /** - An enum that represents states of the PFPurchaseTableViewCell. - @see PFPurchaseTableViewCell + An enum that represents states of the `PFPurchaseTableViewCell`. + @see `PFPurchaseTableViewCell` */ typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) { /** Normal state of the cell. */ @@ -40,16 +40,16 @@ typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) { }; /** - `PFPurchaseTableViewCell` is a subclass that is used to show - products in a . + `PFPurchaseTableViewCell` is a subclass `PFTableViewCell` that is used to show + products in a `PFProductTableViewController`. - @see PFProductTableViewController + @see `PFProductTableViewController` */ @interface PFPurchaseTableViewCell : PFTableViewCell /** State of the cell. - @see PFPurchaseTableViewCellState + @see `PFPurchaseTableViewCellState` */ @property (nonatomic, assign) PFPurchaseTableViewCellState state; diff --git a/ParseUI/Classes/Cells/PFTableViewCell.h b/ParseUI/Classes/Cells/PFTableViewCell.h index 9714162..fe62c78 100644 --- a/ParseUI/Classes/Cells/PFTableViewCell.h +++ b/ParseUI/Classes/Cells/PFTableViewCell.h @@ -29,15 +29,15 @@ NS_ASSUME_NONNULL_BEGIN /** The `PFTableViewCell` class represents a table view cell which can download and display remote images stored on Parse. - When used in a - downloading and displaying of the remote images - are automatically managed by the . + When used in a `PFQueryTableViewController` - downloading and + displaying of the remote images are automatically managed by the controller. */ @interface PFTableViewCell : UITableViewCell /** The imageView of the table view cell. - @see PFImageView + @see `PFImageView` */ @property (nullable, nonatomic, strong, readonly) PFImageView *imageView; diff --git a/ParseUI/Classes/LogInViewController/PFLogInView.h b/ParseUI/Classes/LogInViewController/PFLogInView.h index cd4ad25..624fa7d 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInView.h +++ b/ParseUI/Classes/LogInViewController/PFLogInView.h @@ -60,7 +60,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { @class PFTextField; /** - The `PFLogInView` class provides a standard log in interface for authenticating a . + The `PFLogInView` class provides a standard log in interface for authenticating a `PFUser`. */ @interface PFLogInView : UIScrollView diff --git a/ParseUI/Classes/LogInViewController/PFLogInViewController.h b/ParseUI/Classes/LogInViewController/PFLogInViewController.h index d31ec32..e952f8d 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.h +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.h @@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN @protocol PFLogInViewControllerDelegate; /** - The `PFLogInViewController` class presents and manages a standard authentication interface for logging in a . + The `PFLogInViewController` class presents and manages a standard authentication interface for logging in a `PFUser`. */ @interface PFLogInViewController : UIViewController @@ -84,7 +84,7 @@ NS_ASSUME_NONNULL_BEGIN Whether to prompt for the email as username on the login view. If set to `YES`, we'll prompt for the email in the username field. - This property value propagates to the attached . + This property value propagates to the attached `signUpController`. By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -116,7 +116,7 @@ extern NSString *const PFLogInCancelNotification; ///-------------------------------------- /** - The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a should implement. + The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a `PFLogInViewController` should implement. All methods of this protocol are optional. */ @protocol PFLogInViewControllerDelegate @@ -145,10 +145,10 @@ shouldBeginLogInWithUsername:(NSString *)username ///-------------------------------------- /** - Sent to the delegate when a is logged in. + Sent to the delegate when a `PFUser` is logged in. @param logInController The login view controller where login finished. - @param user object that is a result of the login. + @param user `PFUser` object that is a result of the login. */ - (void)logInViewController:(PFLogInViewController *)logInController didLogInUser:(PFUser *)user; diff --git a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h index 74e1a19..e7ac8aa 100644 --- a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h +++ b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h @@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN @class PFQuery; /** - This class allows you to think about a one-to-one mapping between a and a `UICollectionViewCell`, + This class allows you to think about a one-to-one mapping between a `PFObject` and a `UICollectionViewCell`, rather than having to juggle index paths. You also get the following features out of the box: @@ -43,12 +43,12 @@ NS_ASSUME_NONNULL_BEGIN - Automatic loading and management of the objects array. - Various methods that can be overridden to customize behavior at major events in the data cycle. - @see PFCollectionViewCell + @see `PFCollectionViewCell` */ @interface PFQueryCollectionViewController : UICollectionViewController /** - The class name of the this collection will use as a datasource. + The class name of the `PFObject` this collection will use as a datasource. */ @property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName; @@ -83,19 +83,19 @@ NS_ASSUME_NONNULL_BEGIN /** Initializes a view controller with a `UICollectionViewFlowLayout` and a class name - of that will be associated with this collection. + of `PFObject` that will be associated with this collection. - @param className The class name of the instances of that this table will display. + @param className The class name of the instances of `PFObject` that this table will display. @return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created. */ - (instancetype)initWithClassName:(nullable NSString *)className; /** - Initializes a view controller with a class name of that will be associated with this collection. + Initializes a view controller with a class name of `PFObject` that will be associated with this collection. @param layout Layout for collection view to use. - @param className The class name of the instances of that this table will display. + @param className The class name of the instances of `PFObject` that this table will display. @return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created. */ @@ -124,7 +124,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - The array of instances of that is used as a data source. + The array of instances of `PFObject` that is used as a data source. */ @property (nonatomic, copy, readonly) NSArray *objects; @@ -162,7 +162,7 @@ NS_ASSUME_NONNULL_BEGIN - (BFTask *)loadObjects; /** - Loads the objects of the at the specified page and appends it to the + Loads the objects of the `PFObject.parseClassName` at the specified page and appends it to the objects already loaded and refreshes the collection. @param page The page of objects to load. @@ -187,7 +187,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - Override to construct your own custom to get the objects. + Override to construct your own custom `PFQuery` to get the objects. @return An instance of `PFQuery` that `-loadObjects` method will use to the objects for this collection. */ @@ -198,13 +198,13 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - Override this method to customize each cell given a that is loaded. + Override this method to customize each cell given a `PFObject` that is loaded. - @warning The cell should inherit from which is a subclass of `UICollectionViewCell`. + @warning The cell should inherit from `PFCollectionViewCell` which is a subclass of `UICollectionViewCell`. @param collectionView The collection view object associated with this controller. @param indexPath The indexPath of the cell. - @param object The that is associated with the cell. + @param object The `PFObject` that is associated with the cell. @return The cell that represents this object. */ diff --git a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h index 9205759..e8b3e0d 100644 --- a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h +++ b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h @@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN @class PFTableViewCell; /** - This class allows you to think about a one-to-one mapping between a and a `UITableViewCell`, + This class allows you to think about a one-to-one mapping between a `PFObject` and a `UITableViewCell`, rather than having to juggle index paths. You also get the following features out of the box: @@ -50,10 +50,10 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - Initializes with a class name of the that will be associated with this table. + Initializes with a class name of the `PFObject` that will be associated with this table. @param style The UITableViewStyle for the table - @param className The class name of the instances of that this table will display. + @param className The class name of the instances of `PFObject` that this table will display. @return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created. */ @@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN /** Initializes with a class name of the PFObjects that will be associated with this table. - @param className The class name of the instances of that this table will display. + @param className The class name of the instances of `PFObject` that this table will display. @return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created. */ @@ -74,28 +74,28 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - The class name of the this table will use as a datasource. + The class name of the `PFObject` this table will use as a datasource. */ @property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName; /** The key to use to display for the cell text label. - This won't apply if you override + This won't apply if you override `-tableView:cellForRowAtIndexPath:object:` */ @property (nullable, nonatomic, copy) IBInspectable NSString *textKey; /** The key to use to display for the cell image view. - This won't apply if you override + This won't apply if you override `-tableView:cellForRowAtIndexPath:object:` */ @property (nullable, nonatomic, copy) IBInspectable NSString *imageKey; /** The image to use as a placeholder for the cell images. - This won't apply if you override + This won't apply if you override `-tableView:cellForRowAtIndexPath:object:` */ @property (nullable, nonatomic, strong) IBInspectable UIImage *placeholderImage; @@ -146,7 +146,7 @@ NS_ASSUME_NONNULL_BEGIN ///-------------------------------------- /** - The array of instances of that is used as a data source. + The array of instances of `PFObject` that is used as a data source. */ @property (nullable, nonatomic, copy, readonly) NSArray *objects; @@ -230,7 +230,7 @@ NS_ASSUME_NONNULL_BEGIN If you don't override this method, it will use a default style cell and display either the first data key from the object, or it will display the key as specified with `textKey`, `imageKey`. - @warning The cell should inherit from which is a subclass of `UITableViewCell`. + @warning The cell should inherit from `PFTableViewCell` which is a subclass of `UITableViewCell`. @param tableView The table view object associated with this controller. @param indexPath The indexPath of the cell. diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpView.h b/ParseUI/Classes/SignUpViewController/PFSignUpView.h index 891472a..e638327 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpView.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpView.h @@ -52,7 +52,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { @class PFTextField; /** - The `PFSignUpView` class provides a standard sign up interface for authenticating a . + The `PFSignUpView` class provides a standard sign up interface for authenticating a `PFUser`. */ @interface PFSignUpView : UIScrollView diff --git a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h index 0b34d83..2d9c7e9 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h @@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN /** The `PFSignUpViewController` class that presents and manages - a standard authentication interface for signing up a . + a standard authentication interface for signing up a `PFUser`. */ @interface PFSignUpViewController : UIViewController @@ -70,11 +70,11 @@ NS_ASSUME_NONNULL_BEGIN @property (nonatomic, assign) NSUInteger minPasswordLength; /** - Whether to use the email as username on the attached . + Whether to use the email as username on the attached `signUpView`. If set to `YES`, we'll hide the email field, prompt for the email in the username field, and save the email into both username and email - fields on the new object. By default, this is set to `NO`. + fields on the new `PFUser` object. By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -106,7 +106,7 @@ extern NSString *const PFSignUpCancelNotification; ///-------------------------------------- /** - The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a should implement. + The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a `PFSignUpViewController` should implement. All methods of this protocol are optional. */ @protocol PFSignUpViewControllerDelegate @@ -132,10 +132,10 @@ extern NSString *const PFSignUpCancelNotification; ///-------------------------------------- /** - Sent to the delegate when a is signed up. + Sent to the delegate when a `PFUser` is signed up. @param signUpController The signup view controller where signup finished. - @param user object that is a result of the sign up. + @param user `PFUser` object that is a result of the sign up. */ - (void)signUpViewController:(PFSignUpViewController *)signUpController didSignUpUser:(PFUser *)user; diff --git a/ParseUI/Classes/Views/PFImageView.h b/ParseUI/Classes/Views/PFImageView.h index 19f58c9..e5eea45 100644 --- a/ParseUI/Classes/Views/PFImageView.h +++ b/ParseUI/Classes/Views/PFImageView.h @@ -38,7 +38,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError * /** The remote file on Parse's server that stores the image. - @warning Note that the download does not start until is called. + @warning Note that the download does not start until `-loadInBackground:` is called. */ @property (nullable, nonatomic, strong) PFFile *file; diff --git a/ParseUI/Classes/Views/PFTextField.h b/ParseUI/Classes/Views/PFTextField.h index f77e8dc..4e6f878 100644 --- a/ParseUI/Classes/Views/PFTextField.h +++ b/ParseUI/Classes/Views/PFTextField.h @@ -49,7 +49,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){ /** Separator style bitmask that should be applied to this textfield. - Default: + Default: `PFTextFieldSeparatorStyleNone` @see PFTextFieldSeparatorStyle */