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

Commit da4baf9

Browse files
committed
Replace returns with return keyword for method documentation.
1 parent 6d65439 commit da4baf9

File tree

8 files changed

+21
-21
lines changed

8 files changed

+21
-21
lines changed

ParseUI/Classes/LogInViewController/PFLogInView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
7373
7474
@param fields A bitmask specifying the log in elements which are enabled in the view
7575
76-
@returns An initialized `PFLogInView` object or `nil` if the object couldn't be created.
76+
@return An initialized `PFLogInView` object or `nil` if the object couldn't be created.
7777
7878
@see PFLogInFields
7979
*/

ParseUI/Classes/LogInViewController/PFLogInViewController.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ extern NSString *const PFLogInCancelNotification;
134134
@param username the username the user tries to log in with.
135135
@param password the password the user tries to log in with.
136136
137-
@returns A `BOOL` indicating whether the log in should proceed.
137+
@return A `BOOL` indicating whether the log in should proceed.
138138
*/
139139
- (BOOL)logInViewController:(PFLogInViewController *)logInController
140140
shouldBeginLogInWithUsername:(NSString *)username

ParseUI/Classes/ProductTableViewController/PFProductTableViewController.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ NS_ASSUME_NONNULL_BEGIN
3838
3939
@param style The UITableViewStyle for the table
4040
41-
@returns An initialized `PFProductTableViewController` object or `nil` if the object couldn't be created.
41+
@return An initialized `PFProductTableViewController` object or `nil` if the object couldn't be created.
4242
*/
4343
- (instancetype)initWithStyle:(UITableViewStyle)style NS_DESIGNATED_INITIALIZER;
4444

ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ NS_ASSUME_NONNULL_BEGIN
8787
8888
@param className The class name of the instances of <PFObject> that this table will display.
8989
90-
@returns An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created.
90+
@return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created.
9191
*/
9292
- (instancetype)initWithClassName:(nullable NSString *)className;
9393

@@ -97,7 +97,7 @@ NS_ASSUME_NONNULL_BEGIN
9797
@param layout Layout for collection view to use.
9898
@param className The class name of the instances of <PFObject> that this table will display.
9999
100-
@returns An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created.
100+
@return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created.
101101
*/
102102
- (instancetype)initWithCollectionViewLayout:(UICollectionViewLayout *)layout
103103
className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER;
@@ -136,7 +136,7 @@ NS_ASSUME_NONNULL_BEGIN
136136
137137
@param indexPath An instance of `NSIndexPath`.
138138
139-
@returns The object at the specified indexPath.
139+
@return The object at the specified indexPath.
140140
*/
141141
- (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath;
142142

@@ -157,7 +157,7 @@ NS_ASSUME_NONNULL_BEGIN
157157
/**
158158
Clears the collection view and loads the first page of objects.
159159
160-
@returns An awaitable task that completes when the reload succeeds
160+
@return An awaitable task that completes when the reload succeeds
161161
*/
162162
- (BFTask *)loadObjects;
163163

@@ -168,7 +168,7 @@ NS_ASSUME_NONNULL_BEGIN
168168
@param page The page of objects to load.
169169
@param clear Whether to clear the collection view after receiving the objects.
170170
171-
@returns An awaitable task that completes when the reload succeeds
171+
@return An awaitable task that completes when the reload succeeds
172172
*/
173173
- (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear;
174174

@@ -189,7 +189,7 @@ NS_ASSUME_NONNULL_BEGIN
189189
/**
190190
Override to construct your own custom <PFQuery> to get the objects.
191191
192-
@returns An instance of <PFQuery> that <loadObjects> method will use to the objects for this collection.
192+
@return An instance of `PFQuery` that `-loadObjects` method will use to the objects for this collection.
193193
*/
194194
- (PFQuery *)queryForCollection;
195195

@@ -206,7 +206,7 @@ NS_ASSUME_NONNULL_BEGIN
206206
@param indexPath The indexPath of the cell.
207207
@param object The <PFObject> that is associated with the cell.
208208
209-
@returns The cell that represents this object.
209+
@return The cell that represents this object.
210210
*/
211211
- (nullable PFCollectionViewCell *)collectionView:(UICollectionView *)collectionView
212212
cellForItemAtIndexPath:(NSIndexPath *)indexPath
@@ -218,7 +218,7 @@ NS_ASSUME_NONNULL_BEGIN
218218
219219
@param collectionView The collection view object associated with this controller.
220220
221-
@returns The view that allows the user to paginate.
221+
@return The view that allows the user to paginate.
222222
*/
223223
- (nullable UICollectionReusableView *)collectionViewReusableViewForNextPageAction:(UICollectionView *)collectionView;
224224

ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ NS_ASSUME_NONNULL_BEGIN
5555
@param style The UITableViewStyle for the table
5656
@param className The class name of the instances of <PFObject> that this table will display.
5757
58-
@returns An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created.
58+
@return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created.
5959
*/
6060
- (instancetype)initWithStyle:(UITableViewStyle)style
6161
className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER;
@@ -65,7 +65,7 @@ NS_ASSUME_NONNULL_BEGIN
6565
6666
@param className The class name of the instances of <PFObject> that this table will display.
6767
68-
@returns An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created.
68+
@return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created.
6969
*/
7070
- (instancetype)initWithClassName:(nullable NSString *)className;
7171

@@ -158,7 +158,7 @@ NS_ASSUME_NONNULL_BEGIN
158158
159159
@param indexPath The indexPath.
160160
161-
@returns The object at the specified index
161+
@return The object at the specified index
162162
*/
163163
- (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath;
164164

@@ -190,7 +190,7 @@ NS_ASSUME_NONNULL_BEGIN
190190
/**
191191
Clears the table and loads the first page of objects.
192192
193-
@returns An awaitable task that completes when the reload succeeds
193+
@return An awaitable task that completes when the reload succeeds
194194
*/
195195
- (BFTask *)loadObjects;
196196

@@ -201,7 +201,7 @@ NS_ASSUME_NONNULL_BEGIN
201201
@param page The page of objects to load.
202202
@param clear Whether to clear the table after receiving the objects
203203
204-
@returns An awaitable task that completes when the reload succeeds
204+
@return An awaitable task that completes when the reload succeeds
205205
*/
206206
- (BFTask *)loadObjects:(NSInteger)page clear:(BOOL)clear;
207207

@@ -236,7 +236,7 @@ NS_ASSUME_NONNULL_BEGIN
236236
@param indexPath The indexPath of the cell.
237237
@param object The PFObject that is associated with the cell.
238238
239-
@returns The cell that represents this object.
239+
@return The cell that represents this object.
240240
*/
241241
- (nullable PFTableViewCell *)tableView:(UITableView *)tableView
242242
cellForRowAtIndexPath:(NSIndexPath *)indexPath
@@ -249,7 +249,7 @@ NS_ASSUME_NONNULL_BEGIN
249249
@param tableView The table view object associated with this controller.
250250
@param indexPath The indexPath of the cell.
251251
252-
@returns The cell that allows the user to paginate.
252+
@return The cell that allows the user to paginate.
253253
*/
254254
- (nullable PFTableViewCell *)tableView:(UITableView *)tableView
255255
cellForNextPageAtIndexPath:(NSIndexPath *)indexPath;

ParseUI/Classes/SignUpViewController/PFSignUpView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) {
6565
6666
@param fields A bitmask specifying the sign up elements which are enabled in the view
6767
68-
@returns An initialized `PFSignUpView` object or `nil` if the object couldn't be created.
68+
@return An initialized `PFSignUpView` object or `nil` if the object couldn't be created.
6969
7070
@see PFSignUpFields
7171
*/

ParseUI/Classes/SignUpViewController/PFSignUpViewController.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ extern NSString *const PFSignUpCancelNotification;
123123
@param signUpController The signup view controller that is requesting the data.
124124
@param info An `NSDictionary` instance which contains all sign up information that the user entered.
125125
126-
@returns A `BOOL` indicating whether the sign up should proceed.
126+
@return A `BOOL` indicating whether the sign up should proceed.
127127
*/
128128
- (BOOL)signUpViewController:(PFSignUpViewController *)signUpController shouldBeginSignUp:(NSDictionary *)info;
129129

ParseUI/Classes/Views/PFImageView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError *
4747
4848
Once the download completes, the remote image will be displayed.
4949
50-
@returns The task, that encapsulates the work being done.
50+
@return The task, that encapsulates the work being done.
5151
*/
5252
- (BFTask *)loadInBackground;
5353

0 commit comments

Comments
 (0)