Skip to content
This repository was archived by the owner on Jan 16, 2021. It is now read-only.

Commit 6d65439

Browse files
committed
Remove discussion keyword from method documentation.
1 parent e7c9112 commit 6d65439

File tree

9 files changed

+26
-26
lines changed

9 files changed

+26
-26
lines changed

ParseUI/Classes/Cells/PFCollectionViewCell.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ NS_ASSUME_NONNULL_BEGIN
4949
/**
5050
This method should update all the relevant information inside a subclass of `PFCollectionViewCell`.
5151
52-
@discussion This method is automatically called by <PFQueryCollectionViewController> whenever the cell
52+
This method is automatically called by <PFQueryCollectionViewController> whenever the cell
5353
should display new information. By default this method does nothing.
5454
5555
@param object An instance of `PFObject` to update from.

ParseUI/Classes/LogInViewController/PFLogInView.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
8282
/**
8383
The view controller that will present this view.
8484
85-
@discussion Used to lay out elements correctly when the presenting view controller has translucent elements.
85+
Used to lay out elements correctly when the presenting view controller has translucent elements.
8686
*/
8787
@property (nullable, nonatomic, weak) UIViewController *presentingViewController;
8888

@@ -100,7 +100,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
100100
/**
101101
If email should be used to log in, instead of username
102102
103-
@discussion By default, this is set to `NO`.
103+
By default, this is set to `NO`.
104104
*/
105105
@property (nonatomic, assign) BOOL emailAsUsername;
106106

ParseUI/Classes/LogInViewController/PFLogInViewController.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,22 +68,22 @@ NS_ASSUME_NONNULL_BEGIN
6868
/**
6969
The facebook permissions that Facebook log in requests for.
7070
71-
@discussion If unspecified, the default is basic facebook permissions.
71+
If unspecified, the default is basic facebook permissions.
7272
*/
7373
@property (nullable, nonatomic, copy) NSArray *facebookPermissions;
7474

7575
/**
7676
The sign up controller if sign up is enabled.
7777
78-
@discussion Use this to configure the sign up view, and the transition animation to the sign up view.
78+
Use this to configure the sign up view, and the transition animation to the sign up view.
7979
The default is a sign up view with a username, a password, a dismiss button and a sign up button.
8080
*/
8181
@property (nullable, nonatomic, strong) PFSignUpViewController *signUpController;
8282

8383
/**
8484
Whether to prompt for the email as username on the login view.
8585
86-
@discussion If set to `YES`, we'll prompt for the email in the username field.
86+
If set to `YES`, we'll prompt for the email in the username field.
8787
This property value propagates to the attached <signUpController>.
8888
By default, this is set to `NO`.
8989
*/
@@ -102,7 +102,7 @@ extern NSString *const PFLogInSuccessNotification;
102102

103103
/**
104104
The notification is posted immediately after the log in fails.
105-
@discussion If the delegate prevents the log in from starting, the notification is not sent.
105+
If the delegate prevents the log in from starting, the notification is not sent.
106106
*/
107107
extern NSString *const PFLogInFailureNotification;
108108

@@ -155,7 +155,7 @@ shouldBeginLogInWithUsername:(NSString *)username
155155
/**
156156
Sent to the delegate when the log in attempt fails.
157157
158-
@discussion If you implement this method, PFLoginViewController will not automatically show its default
158+
If you implement this method, PFLoginViewController will not automatically show its default
159159
login failure alert view. Instead, you should show your custom alert view in your implementation.
160160
161161
@param logInController The login view controller where login failed.

ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ NS_ASSUME_NONNULL_BEGIN
131131
/**
132132
Returns an object at a particular indexPath.
133133
134-
@discussion The default impementation returns the object at `indexPath.item`.
134+
The default impementation returns the object at `indexPath.item`.
135135
If you want to return objects in a different indexPath order, like for sections, override this method.
136136
137137
@param indexPath An instance of `NSIndexPath`.
@@ -213,7 +213,7 @@ NS_ASSUME_NONNULL_BEGIN
213213
object:(nullable PFObject *)object;
214214

215215
/**
216-
@discussion Override this method to customize the view that allows the user to load the
216+
Override this method to customize the view that allows the user to load the
217217
next page when pagination is turned on.
218218
219219
@param collectionView The collection view object associated with this controller.

ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,21 @@ NS_ASSUME_NONNULL_BEGIN
8181
/**
8282
The key to use to display for the cell text label.
8383
84-
@discussion This won't apply if you override <tableView:cellForRowAtIndexPath:object:>
84+
This won't apply if you override <tableView:cellForRowAtIndexPath:object:>
8585
*/
8686
@property (nullable, nonatomic, copy) IBInspectable NSString *textKey;
8787

8888
/**
8989
The key to use to display for the cell image view.
9090
91-
@discussion This won't apply if you override <tableView:cellForRowAtIndexPath:object:>
91+
This won't apply if you override <tableView:cellForRowAtIndexPath:object:>
9292
*/
9393
@property (nullable, nonatomic, copy) IBInspectable NSString *imageKey;
9494

9595
/**
9696
The image to use as a placeholder for the cell images.
9797
98-
@discussion This won't apply if you override <tableView:cellForRowAtIndexPath:object:>
98+
This won't apply if you override <tableView:cellForRowAtIndexPath:object:>
9999
*/
100100
@property (nullable, nonatomic, strong) IBInspectable UIImage *placeholderImage;
101101

@@ -153,7 +153,7 @@ NS_ASSUME_NONNULL_BEGIN
153153
/**
154154
Returns an object at a particular indexPath.
155155
156-
@discussion The default impementation returns the object at `indexPath.row`.
156+
The default impementation returns the object at `indexPath.row`.
157157
If you want to return objects in a different indexPath order, like for sections, override this method.
158158
159159
@param indexPath The indexPath.
@@ -227,7 +227,7 @@ NS_ASSUME_NONNULL_BEGIN
227227
/**
228228
Override this method to customize each cell given a PFObject that is loaded.
229229
230-
@discussion If you don't override this method, it will use a default style cell and display either
230+
If you don't override this method, it will use a default style cell and display either
231231
the first data key from the object, or it will display the key as specified with `textKey`, `imageKey`.
232232
233233
@warning The cell should inherit from <PFTableViewCell> which is a subclass of `UITableViewCell`.
@@ -243,7 +243,7 @@ NS_ASSUME_NONNULL_BEGIN
243243
object:(nullable PFObject *)object;
244244

245245
/**
246-
@discussion Override this method to customize the cell that allows the user to load the
246+
Override this method to customize the cell that allows the user to load the
247247
next page when pagination is turned on.
248248
249249
@param tableView The table view object associated with this controller.

ParseUI/Classes/SignUpViewController/PFSignUpView.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) {
7474
/**
7575
The view controller that will present this view.
7676
77-
@discussion Used to lay out elements correctly when the presenting view controller has translucent elements.
77+
Used to lay out elements correctly when the presenting view controller has translucent elements.
7878
*/
7979
@property (nullable, nonatomic, weak) UIViewController *presentingViewController;
8080

@@ -94,7 +94,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) {
9494
/**
9595
If email should be used to log in, instead of username
9696
97-
@discussion By default, this is set to `NO`.
97+
By default, this is set to `NO`.
9898
*/
9999
@property (nonatomic, assign) BOOL emailAsUsername;
100100

@@ -125,7 +125,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) {
125125
/**
126126
The additional text field. It is `nil` if the element is not enabled.
127127
128-
@discussion This field is intended to be customized.
128+
This field is intended to be customized.
129129
*/
130130
@property (nullable, nonatomic, strong, readonly) PFTextField *additionalField;
131131

ParseUI/Classes/SignUpViewController/PFSignUpViewController.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ NS_ASSUME_NONNULL_BEGIN
7272
/**
7373
Whether to use the email as username on the attached <signUpView>.
7474
75-
@discussion If set to `YES`, we'll hide the email field, prompt for the email in
75+
If set to `YES`, we'll hide the email field, prompt for the email in
7676
the username field, and save the email into both username and email
7777
fields on the new <PFUser> object. By default, this is set to `NO`.
7878
*/
@@ -92,7 +92,7 @@ extern NSString *const PFSignUpSuccessNotification;
9292
/**
9393
The notification is posted immediately after the sign up fails.
9494
95-
@discussion If the delegate prevents the sign up to start, the notification is not sent.
95+
If the delegate prevents the sign up to start, the notification is not sent.
9696
*/
9797
extern NSString *const PFSignUpFailureNotification;
9898

ParseUI/Classes/Views/PFImageView.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError *
4545
/**
4646
Initiate downloading of the remote image.
4747
48-
@discussion Once the download completes, the remote image will be displayed.
48+
Once the download completes, the remote image will be displayed.
4949
5050
@returns The task, that encapsulates the work being done.
5151
*/
@@ -54,7 +54,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError *
5454
/**
5555
Initiate downloading of the remote image.
5656
57-
@discussion Once the download completes, the remote image will be displayed.
57+
Once the download completes, the remote image will be displayed.
5858
5959
@param completion the completion block.
6060
*/
@@ -63,7 +63,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError *
6363
/**
6464
Initiate downloading of the remote image.
6565
66-
@discussion Once the download completes, the remote image will be displayed.
66+
Once the download completes, the remote image will be displayed.
6767
6868
@param completion the completion block.
6969
@param progressBlock called with the download progress as the image is being downloaded.

ParseUI/Classes/Views/PFTextField.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){
4949
/**
5050
Separator style bitmask that should be applied to this textfield.
5151
52-
@discussion Default: <PFTextFieldSeparatorStyleNone>
52+
Default: <PFTextFieldSeparatorStyleNone>
5353
5454
@see PFTextFieldSeparatorStyle
5555
*/
@@ -58,7 +58,7 @@ typedef NS_OPTIONS(uint8_t, PFTextFieldSeparatorStyle){
5858
/**
5959
Color that should be used for the separators, if they are visible.
6060
61-
@discussion Default: `227,227,227,1.0`.
61+
Default: `227,227,227,1.0`.
6262
*/
6363
@property (nullable, nonatomic, strong) UIColor *separatorColor UI_APPEARANCE_SELECTOR;
6464

0 commit comments

Comments
 (0)