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

Commit 23efddb

Browse files
committed
Replace /*! with /** for new doc generation.
1 parent 7db4afc commit 23efddb

File tree

17 files changed

+156
-156
lines changed

17 files changed

+156
-156
lines changed

ParseUI/Classes/Cells/PFCollectionViewCell.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,25 +28,25 @@ NS_ASSUME_NONNULL_BEGIN
2828
@class PFImageView;
2929
@class PFObject;
3030

31-
/*!
31+
/**
3232
The `PFCollectionViewCell` class represents a collection view cell which can
3333
download and display remote images stored on Parse as well as has a default simple text label.
3434
*/
3535
@interface PFCollectionViewCell : UICollectionViewCell
3636

37-
/*!
37+
/**
3838
@abstract A simple lazy-loaded label for the collection view cell.
3939
*/
4040
@property (nonatomic, strong, readonly) UILabel *textLabel;
4141

42-
/*!
42+
/**
4343
@abstract The lazy-loaded imageView of the collection view cell.
4444
4545
@see PFImageView
4646
*/
4747
@property (nonatomic, strong, readonly) PFImageView *imageView;
4848

49-
/*!
49+
/**
5050
@abstract This method should update all the relevant information inside a subclass of `PFCollectionViewCell`.
5151
5252
@discussion This method is automatically called by <PFQueryCollectionViewController> whenever the cell

ParseUI/Classes/Cells/PFPurchaseTableViewCell.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,39 +26,39 @@
2626

2727
NS_ASSUME_NONNULL_BEGIN
2828

29-
/*!
29+
/**
3030
An enum that represents states of the PFPurchaseTableViewCell.
3131
@see PFPurchaseTableViewCell
3232
*/
3333
typedef NS_ENUM(uint8_t, PFPurchaseTableViewCellState) {
34-
/*! Normal state of the cell. */
34+
/** Normal state of the cell. */
3535
PFPurchaseTableViewCellStateNormal = 0,
36-
/*! Downloading state of the cell. */
36+
/** Downloading state of the cell. */
3737
PFPurchaseTableViewCellStateDownloading,
38-
/*! State of the cell, when the product was downloaded. */
38+
/** State of the cell, when the product was downloaded. */
3939
PFPurchaseTableViewCellStateDownloaded
4040
};
4141

42-
/*!
42+
/**
4343
`PFPurchaseTableViewCell` is a subclass <PFTableViewCell> that is used to show
4444
products in a <PFProductTableViewController>.
4545
4646
@see PFProductTableViewController
4747
*/
4848
@interface PFPurchaseTableViewCell : PFTableViewCell
4949

50-
/*!
50+
/**
5151
@abstract State of the cell.
5252
@see PFPurchaseTableViewCellState
5353
*/
5454
@property (nonatomic, assign) PFPurchaseTableViewCellState state;
5555

56-
/*!
56+
/**
5757
@abstract Label where price of the product is displayed.
5858
*/
5959
@property (nullable, nonatomic, strong, readonly) UILabel *priceLabel;
6060

61-
/*!
61+
/**
6262
@abstract Progress view that is shown, when the product is downloading.
6363
*/
6464
@property (nullable, nonatomic, strong, readonly) UIProgressView *progressView;

ParseUI/Classes/Cells/PFTableViewCell.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@
2626

2727
NS_ASSUME_NONNULL_BEGIN
2828

29-
/*!
29+
/**
3030
The `PFTableViewCell` class represents a table view cell which can download and display remote images stored on Parse.
3131
3232
When used in a <PFQueryTableViewController> - downloading and displaying of the remote images
3333
are automatically managed by the <PFQueryTableViewController>.
3434
*/
3535
@interface PFTableViewCell : UITableViewCell
3636

37-
/*!
37+
/**
3838
@abstract The imageView of the table view cell.
3939
4040
@see PFImageView

ParseUI/Classes/Internal/Cells/PFActivityIndicatorCollectionReusableView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#import <UIKit/UIKit.h>
2323

24-
/*!
24+
/**
2525
The `PFActivityIndicatorCollectionReusableView` class represents a collection footer
2626
that has a simple text label and displays UIActivityIndicatorView if <animating> property is set to `YES`.
2727
An instance of this class is used as a default next page button inside <PFQueryCollectionViewController>.

ParseUI/Classes/Internal/Cells/PFActivityIndicatorTableViewCell.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
#import <ParseUI/PFTableViewCell.h>
2525

26-
/*!
26+
/**
2727
The `PFActivityIndicatorTableViewCell` class represents a table view cell
2828
that displays UIActivityIndicatorView as the accessory view.
2929
*/

ParseUI/Classes/Internal/PFImageCache.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#import <UIKit/UIKit.h>
2323

24-
/*!
24+
/**
2525
A memory cache for UIImage, based on NSCache
2626
*/
2727
@interface PFImageCache : NSCache

ParseUI/Classes/Internal/Views/PFLoadingView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#import <UIKit/UIKit.h>
2323

24-
/*!
24+
/**
2525
A loading view that is used to show users that data is being loaded before any data is available.
2626
*/
2727
@interface PFLoadingView : UIView

ParseUI/Classes/LogInViewController/PFLogInView.h

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -25,31 +25,31 @@
2525

2626
NS_ASSUME_NONNULL_BEGIN
2727

28-
/*!
28+
/**
2929
`PFLogInFields` bitmask specifies the log in elements which are enabled in the view.
3030
3131
@see PFLogInViewController
3232
@see PFLogInView
3333
*/
3434
typedef NS_OPTIONS(NSInteger, PFLogInFields) {
35-
/*! No fields. */
35+
/** No fields. */
3636
PFLogInFieldsNone = 0,
37-
/*! Username and password fields. */
37+
/** Username and password fields. */
3838
PFLogInFieldsUsernameAndPassword = 1 << 0,
39-
/*! Forgot password button. */
39+
/** Forgot password button. */
4040
PFLogInFieldsPasswordForgotten = 1 << 1,
41-
/*! Login button. */
41+
/** Login button. */
4242
PFLogInFieldsLogInButton = 1 << 2,
43-
/*! Button to login with Facebook. */
43+
/** Button to login with Facebook. */
4444
PFLogInFieldsFacebook = 1 << 3,
45-
/*! Button to login with Twitter. */
45+
/** Button to login with Twitter. */
4646
PFLogInFieldsTwitter = 1 << 4,
47-
/*! Signup Button. */
47+
/** Signup Button. */
4848
PFLogInFieldsSignUpButton = 1 << 5,
49-
/*! Dismiss Button. */
49+
/** Dismiss Button. */
5050
PFLogInFieldsDismissButton = 1 << 6,
5151

52-
/*! Default value. Combines Username, Password, Login, Signup, Forgot Password and Dismiss buttons. */
52+
/** Default value. Combines Username, Password, Login, Signup, Forgot Password and Dismiss buttons. */
5353
PFLogInFieldsDefault = (PFLogInFieldsUsernameAndPassword |
5454
PFLogInFieldsLogInButton |
5555
PFLogInFieldsSignUpButton |
@@ -59,7 +59,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
5959

6060
@class PFTextField;
6161

62-
/*!
62+
/**
6363
The `PFLogInView` class provides a standard log in interface for authenticating a <PFUser>.
6464
*/
6565
@interface PFLogInView : UIScrollView
@@ -68,7 +68,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
6868
/// @name Creating Log In View
6969
///--------------------------------------
7070

71-
/*!
71+
/**
7272
@abstract Initializes the view with the specified log in elements.
7373
7474
@param fields A bitmask specifying the log in elements which are enabled in the view
@@ -79,7 +79,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
7979
*/
8080
- (instancetype)initWithFields:(PFLogInFields)fields;
8181

82-
/*!
82+
/**
8383
@abstract The view controller that will present this view.
8484
8585
@discussion Used to lay out elements correctly when the presenting view controller has translucent elements.
@@ -97,7 +97,7 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
9797
/// @name Configure Username Behaviour
9898
///--------------------------------------
9999

100-
/*!
100+
/**
101101
@abstract If email should be used to log in, instead of username
102102
103103
@discussion By default, this is set to `NO`.
@@ -108,59 +108,59 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {
108108
/// @name Log In Elements
109109
///--------------------------------------
110110

111-
/*!
111+
/**
112112
@abstract The bitmask which specifies the enabled log in elements in the view.
113113
*/
114114
@property (nonatomic, assign, readonly) PFLogInFields fields;
115115

116-
/*!
116+
/**
117117
@abstract The username text field. It is `nil` if the element is not enabled.
118118
*/
119119
@property (nullable, nonatomic, strong, readonly) PFTextField *usernameField;
120120

121-
/*!
121+
/**
122122
@abstract The password text field. It is `nil` if the element is not enabled.
123123
*/
124124
@property (nullable, nonatomic, strong, readonly) PFTextField *passwordField;
125125

126-
/*!
126+
/**
127127
@abstract The password forgotten button. It is `nil` if the element is not enabled.
128128
*/
129129
@property (nullable, nonatomic, strong, readonly) UIButton *passwordForgottenButton;
130130

131-
/*!
131+
/**
132132
@abstract The log in button. It is `nil` if the element is not enabled.
133133
*/
134134
@property (nullable, nonatomic, strong, readonly) UIButton *logInButton;
135135

136-
/*!
136+
/**
137137
@abstract The Facebook button. It is `nil` if the element is not enabled.
138138
*/
139139
@property (nullable, nonatomic, strong, readonly) UIButton *facebookButton;
140140

141-
/*!
141+
/**
142142
@abstract The Twitter button. It is `nil` if the element is not enabled.
143143
*/
144144
@property (nullable, nonatomic, strong, readonly) UIButton *twitterButton;
145145

146-
/*!
146+
/**
147147
@abstract The sign up button. It is `nil` if the element is not enabled.
148148
*/
149149
@property (nullable, nonatomic, strong, readonly) UIButton *signUpButton;
150150

151-
/*!
151+
/**
152152
@abstract It is `nil` if the element is not enabled.
153153
*/
154154
@property (nullable, nonatomic, strong, readonly) UIButton *dismissButton;
155155

156-
/*!
156+
/**
157157
@abstract The facebook/twitter login label.
158158
159159
@deprecated This property is deprecated and will always be nil.
160160
*/
161161
@property (nullable, nonatomic, strong, readonly) UILabel *externalLogInLabel __attribute__(PARSE_UI_DEPRECATED("This property is deprecated and will always be nil."));
162162

163-
/*!
163+
/**
164164
@abstract The sign up label.
165165
166166
@deprecated This property is deprecated and will always be nil.

0 commit comments

Comments
 (0)