diff --git a/ParseUI/Classes/Cells/PFCollectionViewCell.h b/ParseUI/Classes/Cells/PFCollectionViewCell.h index 13d7570..9abb31e 100644 --- a/ParseUI/Classes/Cells/PFCollectionViewCell.h +++ b/ParseUI/Classes/Cells/PFCollectionViewCell.h @@ -28,28 +28,28 @@ 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. +/** + 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 + 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 f954dda..88e0e85 100644 --- a/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h +++ b/ParseUI/Classes/Cells/PFPurchaseTableViewCell.h @@ -26,40 +26,40 @@ 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. */ + /** 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 . +/** + `PFPurchaseTableViewCell` is a subclass `PFTableViewCell` that is used to show + products in a `PFProductTableViewController`. - @see PFProductTableViewController + @see `PFProductTableViewController` */ @interface PFPurchaseTableViewCell : PFTableViewCell -/*! - @abstract State of the cell. - @see PFPurchaseTableViewCellState +/** + 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 173df06..fe62c78 100644 --- a/ParseUI/Classes/Cells/PFTableViewCell.h +++ b/ParseUI/Classes/Cells/PFTableViewCell.h @@ -26,18 +26,18 @@ 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 -/*! - @abstract The imageView of the table view cell. +/** + The imageView of the table view cell. - @see PFImageView + @see `PFImageView` */ @property (nullable, nonatomic, strong, readonly) PFImageView *imageView; 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..624fa7d 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,8 +59,8 @@ 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 @@ -68,21 +68,21 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /// @name Creating Log In View ///-------------------------------------- -/*! - @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 - @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 */ - (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. + Used to lay out elements correctly when the presenting view controller has translucent elements. */ @property (nullable, nonatomic, weak) UIViewController *presentingViewController; @@ -97,10 +97,10 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /// @name Configure Username Behaviour ///-------------------------------------- -/*! - @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`. + By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -108,60 +108,60 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) { /// @name Log In Elements ///-------------------------------------- -/*! - @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 e21a737..e952f8d 100644 --- a/ParseUI/Classes/LogInViewController/PFLogInViewController.h +++ b/ParseUI/Classes/LogInViewController/PFLogInViewController.h @@ -30,8 +30,8 @@ NS_ASSUME_NONNULL_BEGIN @class PFUser; @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 @@ -39,16 +39,16 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Log In Elements ///-------------------------------------- -/*! - @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 */ @property (nonatomic, assign) PFLogInFields fields; -/*! - @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 */ @@ -58,33 +58,33 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Log In Behaviors ///-------------------------------------- -/*! - @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. + 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. + 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; -/*! - @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 . + If set to `YES`, we'll prompt for the email in the username field. + This property value propagates to the attached `signUpController`. By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -95,19 +95,19 @@ NS_ASSUME_NONNULL_BEGIN /// @name Notifications ///-------------------------------------- -/*! - @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. - @discussion If the delegate prevents the log in from starting, the notification is not sent. +/** + The notification is posted immediately after the log in fails. + 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; @@ -115,8 +115,8 @@ extern NSString *const PFLogInCancelNotification; /// @name PFLogInViewControllerDelegate ///-------------------------------------- -/*! - 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 @@ -127,14 +127,14 @@ 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. +/** + 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. @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 @@ -144,18 +144,18 @@ shouldBeginLogInWithUsername:(NSString *)username /// @name Responding to Actions ///-------------------------------------- -/*! - @abstract 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; -/*! - @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 + 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. @@ -164,8 +164,8 @@ shouldBeginLogInWithUsername:(NSString *)username - (void)logInViewController:(PFLogInViewController *)logInController 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/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..6ee0849 100644 --- a/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h +++ b/ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h @@ -26,19 +26,19 @@ 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. +/** + Initializes a product table view controller. @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 b8b7ce9..e7ac8aa 100644 --- a/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h +++ b/ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h @@ -30,8 +30,8 @@ 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`, +/** + 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,37 +43,37 @@ 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 -/*! - @abstract 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; -/*! - @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; @@ -81,23 +81,23 @@ 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. +/** + Initializes a view controller with a `UICollectionViewFlowLayout` and a class name + 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. - @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; -/*! - @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 `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. - @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; @@ -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,30 +123,30 @@ NS_ASSUME_NONNULL_BEGIN /// @name Accessing Results ///-------------------------------------- -/*! - @abstract 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; -/*! - @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`. + 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`. - @returns The object at the specified indexPath. + @return The object at the specified indexPath. */ - (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; @@ -154,31 +154,31 @@ NS_ASSUME_NONNULL_BEGIN /// @name Loading Data ///-------------------------------------- -/*! - @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 + @return 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 `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. @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; -/*! - @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; @@ -186,10 +186,10 @@ NS_ASSUME_NONNULL_BEGIN /// @name Querying ///-------------------------------------- -/*! - @abstract Override to construct your own custom to get the objects. +/** + Override to construct your own custom `PFQuery` 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; @@ -197,28 +197,28 @@ NS_ASSUME_NONNULL_BEGIN /// @name Data Source Methods ///-------------------------------------- -/*! - @abstract 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. - @returns The cell that represents this object. + @return The cell that represents this object. */ - (nullable PFCollectionViewCell *)collectionView:(UICollectionView *)collectionView cellForItemAtIndexPath:(NSIndexPath *)indexPath 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. - @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 8bb56a3..e8b3e0d 100644 --- a/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h +++ b/ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h @@ -30,8 +30,8 @@ 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`, +/** + 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: @@ -49,23 +49,23 @@ NS_ASSUME_NONNULL_BEGIN /// @name Creating a PFQueryTableViewController ///-------------------------------------- -/*! - @abstract 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. - @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; -/*! - @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. + @param className The class name of the instances of `PFObject` 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; @@ -73,54 +73,54 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Behavior ///-------------------------------------- -/*! - @abstract 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; -/*! - @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 + This won't apply if you override `-tableView:cellForRowAtIndexPath:object:` */ @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 + This won't apply if you override `-tableView:cellForRowAtIndexPath:object:` */ @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 + This won't apply if you override `-tableView:cellForRowAtIndexPath:object:` */ @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; @@ -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,68 +145,68 @@ NS_ASSUME_NONNULL_BEGIN /// @name Accessing Results ///-------------------------------------- -/*! - @abstract 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; -/*! - @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`. + 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. - @returns The object at the specified index + @return The object at the specified index */ - (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 + @return 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. @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; -/*! - @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; @@ -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,32 +224,32 @@ NS_ASSUME_NONNULL_BEGIN /// @name Data Source Methods ///-------------------------------------- -/*! - @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 + 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. @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 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. @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 db9d641..e638327 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,8 +51,8 @@ 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 @@ -60,21 +60,21 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Creating SignUp View ///-------------------------------------- -/*! - @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 - @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 */ - (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. + Used to lay out elements correctly when the presenting view controller has translucent elements. */ @property (nullable, nonatomic, weak) UIViewController *presentingViewController; @@ -82,8 +82,8 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Customizing the Logo ///-------------------------------------- -/*! - @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; @@ -91,10 +91,10 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Configure Username Behaviour ///-------------------------------------- -/*! - @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`. + By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -102,40 +102,40 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) { /// @name Sign Up Elements ///-------------------------------------- -/*! - @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. + 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 5e13f4c..2d9c7e9 100644 --- a/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h +++ b/ParseUI/Classes/SignUpViewController/PFSignUpViewController.h @@ -29,9 +29,9 @@ 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 @@ -39,15 +39,15 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Sign Up Elements ///-------------------------------------- -/*! - @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 */ @@ -57,24 +57,24 @@ NS_ASSUME_NONNULL_BEGIN /// @name Configuring Sign Up Behaviors ///-------------------------------------- -/*! - @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 `signUpView`. - @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`. + fields on the new `PFUser` object. By default, this is set to `NO`. */ @property (nonatomic, assign) BOOL emailAsUsername; @@ -84,20 +84,20 @@ NS_ASSUME_NONNULL_BEGIN /// @name Notifications ///-------------------------------------- -/*! - @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. + 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; @@ -105,8 +105,8 @@ extern NSString *const PFSignUpCancelNotification; /// @name PFSignUpViewControllerDelegate ///-------------------------------------- -/*! - 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 @@ -117,13 +117,13 @@ 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. +/** + 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. - @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; @@ -131,16 +131,16 @@ extern NSString *const PFSignUpCancelNotification; /// @name Responding to Actions ///-------------------------------------- -/*! - @abstract 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; -/*! - @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. @@ -148,8 +148,8 @@ extern NSString *const PFSignUpCancelNotification; - (void)signUpViewController:(PFSignUpViewController *)signUpController 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 67c5909..e5eea45 100644 --- a/ParseUI/Classes/Views/PFImageView.h +++ b/ParseUI/Classes/Views/PFImageView.h @@ -30,40 +30,40 @@ 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. +/** + 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; -/*! - @abstract Initiate downloading of the remote image. +/** + 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. + @return The task, that encapsulates the work being done. */ - (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. + Once the download completes, the remote image will be displayed. @param completion the completion block. */ - (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. + 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 c50781e..4e6f878 100644 --- a/ParseUI/Classes/Views/PFTextField.h +++ b/ParseUI/Classes/Views/PFTextField.h @@ -25,44 +25,44 @@ 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. +/** + Separator style bitmask that should be applied to this textfield. - @discussion Default: + Default: `PFTextFieldSeparatorStyleNone` @see 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`. + 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.