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

Commit d4ecd79

Browse files
committed
Update style of cross link annotations in all of the documentation.
1 parent da4baf9 commit d4ecd79

File tree

11 files changed

+48
-48
lines changed

11 files changed

+48
-48
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-
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/Cells/PFPurchaseTableViewCell.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
NS_ASSUME_NONNULL_BEGIN
2828

2929
/**
30-
An enum that represents states of the PFPurchaseTableViewCell.
31-
@see PFPurchaseTableViewCell
30+
An enum that represents states of the `PFPurchaseTableViewCell`.
31+
@see `PFPurchaseTableViewCell`
3232
*/
3333
typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) {
3434
/** Normal state of the cell. */
@@ -40,16 +40,16 @@ typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) {
4040
};
4141

4242
/**
43-
`PFPurchaseTableViewCell` is a subclass <PFTableViewCell> that is used to show
44-
products in a <PFProductTableViewController>.
43+
`PFPurchaseTableViewCell` is a subclass `PFTableViewCell` that is used to show
44+
products in a `PFProductTableViewController`.
4545
46-
@see PFProductTableViewController
46+
@see `PFProductTableViewController`
4747
*/
4848
@interface PFPurchaseTableViewCell : PFTableViewCell
4949

5050
/**
5151
State of the cell.
52-
@see PFPurchaseTableViewCellState
52+
@see `PFPurchaseTableViewCellState`
5353
*/
5454
@property (nonatomic, assign) PFPurchaseTableViewCellState state;
5555

ParseUI/Classes/Cells/PFTableViewCell.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ NS_ASSUME_NONNULL_BEGIN
2929
/**
3030
The `PFTableViewCell` class represents a table view cell which can download and display remote images stored on Parse.
3131
32-
When used in a <PFQueryTableViewController> - downloading and displaying of the remote images
33-
are automatically managed by the <PFQueryTableViewController>.
32+
When used in a `PFQueryTableViewController` - downloading and
33+
displaying of the remote images are automatically managed by the controller.
3434
*/
3535
@interface PFTableViewCell : UITableViewCell
3636

3737
/**
3838
The imageView of the table view cell.
3939
40-
@see PFImageView
40+
@see `PFImageView`
4141
*/
4242
@property (nullable, nonatomic, strong, readonly) PFImageView *imageView;
4343

ParseUI/Classes/LogInViewController/PFLogInView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
6060
@class PFTextField;
6161

6262
/**
63-
The `PFLogInView` class provides a standard log in interface for authenticating a <PFUser>.
63+
The `PFLogInView` class provides a standard log in interface for authenticating a `PFUser`.
6464
*/
6565
@interface PFLogInView : UIScrollView
6666

ParseUI/Classes/LogInViewController/PFLogInViewController.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
3131
@protocol PFLogInViewControllerDelegate;
3232

3333
/**
34-
The `PFLogInViewController` class presents and manages a standard authentication interface for logging in a <PFUser>.
34+
The `PFLogInViewController` class presents and manages a standard authentication interface for logging in a `PFUser`.
3535
*/
3636
@interface PFLogInViewController : UIViewController <UITextFieldDelegate>
3737

@@ -84,7 +84,7 @@ NS_ASSUME_NONNULL_BEGIN
8484
Whether to prompt for the email as username on the login view.
8585
8686
If set to `YES`, we'll prompt for the email in the username field.
87-
This property value propagates to the attached <signUpController>.
87+
This property value propagates to the attached `signUpController`.
8888
By default, this is set to `NO`.
8989
*/
9090
@property (nonatomic, assign) BOOL emailAsUsername;
@@ -116,7 +116,7 @@ extern NSString *const PFLogInCancelNotification;
116116
///--------------------------------------
117117

118118
/**
119-
The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a <PFLogInViewController> should implement.
119+
The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a `PFLogInViewController` should implement.
120120
All methods of this protocol are optional.
121121
*/
122122
@protocol PFLogInViewControllerDelegate <NSObject>
@@ -145,10 +145,10 @@ shouldBeginLogInWithUsername:(NSString *)username
145145
///--------------------------------------
146146

147147
/**
148-
Sent to the delegate when a <PFUser> is logged in.
148+
Sent to the delegate when a `PFUser` is logged in.
149149
150150
@param logInController The login view controller where login finished.
151-
@param user <PFUser> object that is a result of the login.
151+
@param user `PFUser` object that is a result of the login.
152152
*/
153153
- (void)logInViewController:(PFLogInViewController *)logInController didLogInUser:(PFUser *)user;
154154

ParseUI/Classes/QueryCollectionViewController/PFQueryCollectionViewController.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
3131
@class PFQuery;
3232

3333
/**
34-
This class allows you to think about a one-to-one mapping between a <PFObject> and a `UICollectionViewCell`,
34+
This class allows you to think about a one-to-one mapping between a `PFObject` and a `UICollectionViewCell`,
3535
rather than having to juggle index paths.
3636
3737
You also get the following features out of the box:
@@ -43,12 +43,12 @@ NS_ASSUME_NONNULL_BEGIN
4343
- Automatic loading and management of the objects array.
4444
- Various methods that can be overridden to customize behavior at major events in the data cycle.
4545
46-
@see PFCollectionViewCell
46+
@see `PFCollectionViewCell`
4747
*/
4848
@interface PFQueryCollectionViewController : UICollectionViewController <UICollectionViewDelegateFlowLayout>
4949

5050
/**
51-
The class name of the <PFObject> this collection will use as a datasource.
51+
The class name of the `PFObject` this collection will use as a datasource.
5252
*/
5353
@property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName;
5454

@@ -83,19 +83,19 @@ NS_ASSUME_NONNULL_BEGIN
8383

8484
/**
8585
Initializes a view controller with a `UICollectionViewFlowLayout` and a class name
86-
of <PFObject> that will be associated with this collection.
86+
of `PFObject` that will be associated with this collection.
8787
88-
@param className The class name of the instances of <PFObject> that this table will display.
88+
@param className The class name of the instances of `PFObject` that this table will display.
8989
9090
@return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created.
9191
*/
9292
- (instancetype)initWithClassName:(nullable NSString *)className;
9393

9494
/**
95-
Initializes a view controller with a class name of <PFObject> that will be associated with this collection.
95+
Initializes a view controller with a class name of `PFObject` that will be associated with this collection.
9696
9797
@param layout Layout for collection view to use.
98-
@param className The class name of the instances of <PFObject> that this table will display.
98+
@param className The class name of the instances of `PFObject` that this table will display.
9999
100100
@return An initialized `PFQueryCollectionViewController` object or `nil` if the object couldn't be created.
101101
*/
@@ -124,7 +124,7 @@ NS_ASSUME_NONNULL_BEGIN
124124
///--------------------------------------
125125

126126
/**
127-
The array of instances of <PFObject> that is used as a data source.
127+
The array of instances of `PFObject` that is used as a data source.
128128
*/
129129
@property (nonatomic, copy, readonly) NSArray *objects;
130130

@@ -162,7 +162,7 @@ NS_ASSUME_NONNULL_BEGIN
162162
- (BFTask *)loadObjects;
163163

164164
/**
165-
Loads the objects of the <parseClassName> at the specified page and appends it to the
165+
Loads the objects of the `PFObject.parseClassName` at the specified page and appends it to the
166166
objects already loaded and refreshes the collection.
167167
168168
@param page The page of objects to load.
@@ -187,7 +187,7 @@ NS_ASSUME_NONNULL_BEGIN
187187
///--------------------------------------
188188

189189
/**
190-
Override to construct your own custom <PFQuery> to get the objects.
190+
Override to construct your own custom `PFQuery` to get the objects.
191191
192192
@return An instance of `PFQuery` that `-loadObjects` method will use to the objects for this collection.
193193
*/
@@ -198,13 +198,13 @@ NS_ASSUME_NONNULL_BEGIN
198198
///--------------------------------------
199199

200200
/**
201-
Override this method to customize each cell given a <PFObject> that is loaded.
201+
Override this method to customize each cell given a `PFObject` that is loaded.
202202
203-
@warning The cell should inherit from <PFCollectionViewCell> which is a subclass of `UICollectionViewCell`.
203+
@warning The cell should inherit from `PFCollectionViewCell` which is a subclass of `UICollectionViewCell`.
204204
205205
@param collectionView The collection view object associated with this controller.
206206
@param indexPath The indexPath of the cell.
207-
@param object The <PFObject> that is associated with the cell.
207+
@param object The `PFObject` that is associated with the cell.
208208
209209
@return The cell that represents this object.
210210
*/

ParseUI/Classes/QueryTableViewController/PFQueryTableViewController.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
3131
@class PFTableViewCell;
3232

3333
/**
34-
This class allows you to think about a one-to-one mapping between a <PFObject> and a `UITableViewCell`,
34+
This class allows you to think about a one-to-one mapping between a `PFObject` and a `UITableViewCell`,
3535
rather than having to juggle index paths.
3636
3737
You also get the following features out of the box:
@@ -50,10 +50,10 @@ NS_ASSUME_NONNULL_BEGIN
5050
///--------------------------------------
5151

5252
/**
53-
Initializes with a class name of the <PFObject> that will be associated with this table.
53+
Initializes with a class name of the `PFObject` that will be associated with this table.
5454
5555
@param style The UITableViewStyle for the table
56-
@param className The class name of the instances of <PFObject> that this table will display.
56+
@param className The class name of the instances of `PFObject` that this table will display.
5757
5858
@return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created.
5959
*/
@@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN
6363
/**
6464
Initializes with a class name of the PFObjects that will be associated with this table.
6565
66-
@param className The class name of the instances of <PFObject> that this table will display.
66+
@param className The class name of the instances of `PFObject` that this table will display.
6767
6868
@return An initialized `PFQueryTableViewController` object or `nil` if the object couldn't be created.
6969
*/
@@ -74,28 +74,28 @@ NS_ASSUME_NONNULL_BEGIN
7474
///--------------------------------------
7575

7676
/**
77-
The class name of the <PFObject> this table will use as a datasource.
77+
The class name of the `PFObject` this table will use as a datasource.
7878
*/
7979
@property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName;
8080

8181
/**
8282
The key to use to display for the cell text label.
8383
84-
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-
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-
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

@@ -146,7 +146,7 @@ NS_ASSUME_NONNULL_BEGIN
146146
///--------------------------------------
147147

148148
/**
149-
The array of instances of <PFObject> that is used as a data source.
149+
The array of instances of `PFObject` that is used as a data source.
150150
*/
151151
@property (nullable, nonatomic, copy, readonly) NSArray *objects;
152152

@@ -230,7 +230,7 @@ NS_ASSUME_NONNULL_BEGIN
230230
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
233-
@warning The cell should inherit from <PFTableViewCell> which is a subclass of `UITableViewCell`.
233+
@warning The cell should inherit from `PFTableViewCell` which is a subclass of `UITableViewCell`.
234234
235235
@param tableView The table view object associated with this controller.
236236
@param indexPath The indexPath of the cell.

ParseUI/Classes/SignUpViewController/PFSignUpView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ typedef NS_OPTIONS(NSInteger, PFSignUpFields) {
5252
@class PFTextField;
5353

5454
/**
55-
The `PFSignUpView` class provides a standard sign up interface for authenticating a <PFUser>.
55+
The `PFSignUpView` class provides a standard sign up interface for authenticating a `PFUser`.
5656
*/
5757
@interface PFSignUpView : UIScrollView
5858

ParseUI/Classes/SignUpViewController/PFSignUpViewController.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
3131

3232
/**
3333
The `PFSignUpViewController` class that presents and manages
34-
a standard authentication interface for signing up a <PFUser>.
34+
a standard authentication interface for signing up a `PFUser`.
3535
*/
3636
@interface PFSignUpViewController : UIViewController <UITextFieldDelegate, UIScrollViewDelegate>
3737

@@ -70,11 +70,11 @@ NS_ASSUME_NONNULL_BEGIN
7070
@property (nonatomic, assign) NSUInteger minPasswordLength;
7171

7272
/**
73-
Whether to use the email as username on the attached <signUpView>.
73+
Whether to use the email as username on the attached `signUpView`.
7474
7575
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
77-
fields on the new <PFUser> object. By default, this is set to `NO`.
77+
fields on the new `PFUser` object. By default, this is set to `NO`.
7878
*/
7979
@property (nonatomic, assign) BOOL emailAsUsername;
8080

@@ -106,7 +106,7 @@ extern NSString *const PFSignUpCancelNotification;
106106
///--------------------------------------
107107

108108
/**
109-
The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a <PFSignUpViewController> should implement.
109+
The `PFLogInViewControllerDelegate` protocol defines methods a delegate of a `PFSignUpViewController` should implement.
110110
All methods of this protocol are optional.
111111
*/
112112
@protocol PFSignUpViewControllerDelegate <NSObject>
@@ -132,10 +132,10 @@ extern NSString *const PFSignUpCancelNotification;
132132
///--------------------------------------
133133

134134
/**
135-
Sent to the delegate when a <PFUser> is signed up.
135+
Sent to the delegate when a `PFUser` is signed up.
136136
137137
@param signUpController The signup view controller where signup finished.
138-
@param user <PFUser> object that is a result of the sign up.
138+
@param user `PFUser` object that is a result of the sign up.
139139
*/
140140
- (void)signUpViewController:(PFSignUpViewController *)signUpController didSignUpUser:(PFUser *)user;
141141

ParseUI/Classes/Views/PFImageView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ typedef void(^PFImageViewImageResultBlock)(UIImage *__nullable image, NSError *
3838
/**
3939
The remote file on Parse's server that stores the image.
4040
41-
@warning Note that the download does not start until <loadInBackground:> is called.
41+
@warning Note that the download does not start until `-loadInBackground:` is called.
4242
*/
4343
@property (nullable, nonatomic, strong) PFFile *file;
4444

0 commit comments

Comments
 (0)