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

Update all of the public documentation to new style. #211

Merged
merged 5 commits into from
Dec 2, 2015
Merged

Update all of the public documentation to new style. #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
23efddb
Replace /*! with /** for new doc generation.
nlutsenko Dec 2, 2015
e7c9112
Remove abstract keyword from method documentation.
nlutsenko Dec 2, 2015
6d65439
Remove discussion keyword from method documentation.
nlutsenko Dec 2, 2015
da4baf9
Replace returns with return keyword for method documentation.
nlutsenko Dec 2, 2015
d4ecd79
Update style of cross link annotations in all of the documentation.
nlutsenko Dec 2, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions ParseUI/Classes/Cells/PFCollectionViewCell.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PFQueryCollectionViewController> 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.
Expand Down
34 changes: 17 additions & 17 deletions ParseUI/Classes/Cells/PFPurchaseTableViewCell.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PFTableViewCell> that is used to show
products in a <PFProductTableViewController>.
/**
`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;

Expand Down
12 changes: 6 additions & 6 deletions ParseUI/Classes/Cells/PFTableViewCell.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PFQueryTableViewController> - downloading and displaying of the remote images
are automatically managed by the <PFQueryTableViewController>.
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;

Expand Down
2 changes: 1 addition & 1 deletion ParseUI/Classes/Internal/Cells/PFActivityIndicatorCollectionReusableView.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#import <UIKit/UIKit.h>

/*!
/**
The `PFActivityIndicatorCollectionReusableView` class represents a collection footer
that has a simple text label and displays UIActivityIndicatorView if <animating> property is set to `YES`.
An instance of this class is used as a default next page button inside <PFQueryCollectionViewController>.
Expand Down
2 changes: 1 addition & 1 deletion ParseUI/Classes/Internal/Cells/PFActivityIndicatorTableViewCell.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

#import <ParseUI/PFTableViewCell.h>

/*!
/**
The `PFActivityIndicatorTableViewCell` class represents a table view cell
that displays UIActivityIndicatorView as the accessory view.
*/
Expand Down
2 changes: 1 addition & 1 deletion ParseUI/Classes/Internal/PFImageCache.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#import <UIKit/UIKit.h>

/*!
/**
A memory cache for UIImage, based on NSCache
*/
@interface PFImageCache : NSCache
Expand Down
2 changes: 1 addition & 1 deletion ParseUI/Classes/Internal/Views/PFLoadingView.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#import <UIKit/UIKit.h>

/*!
/**
A loading view that is used to show users that data is being loaded before any data is available.
*/
@interface PFLoadingView : UIView
Expand Down
86 changes: 43 additions & 43 deletions ParseUI/Classes/LogInViewController/PFLogInView.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -59,30 +59,30 @@ typedef NS_OPTIONS(NSInteger, PFLogInFields) {

@class PFTextField;

/*!
The `PFLogInView` class provides a standard log in interface for authenticating a <PFUser>.
/**
The `PFLogInView` class provides a standard log in interface for authenticating a `PFUser`.
*/
@interface PFLogInView : UIScrollView

///--------------------------------------
/// @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;

Expand All @@ -97,71 +97,71 @@ 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;

///--------------------------------------
/// @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.
*/
Expand Down