Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 2, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ NS_ASSUME_NONNULL_BEGIN
/// @name Default ACL
///--------------------------------------

/*!
/**
Get the default ACL managed by this controller.

@return A task that returns the ACL encapsulated by this controller.
*/
- (BFTask *)getDefaultACLAsync;

/*!
/**
Set the new default default ACL to be encapsulated in this controller.

@param acl The new ACL. Will be copied.
Expand Down
2 changes: 1 addition & 1 deletion Parse/Internal/ACL/PFACLPrivate.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*/
- (instancetype)initWithDictionary:(NSDictionary *)dictionary;

/*!
/**
Creates an ACL from its encoded format.
*/
+ (instancetype)ACLWithDictionary:(NSDictionary *)dictionary;
Expand Down
12 changes: 6 additions & 6 deletions Parse/Internal/Analytics/Controller/PFAnalyticsController.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,27 @@
/// @name Track Event
///--------------------------------------

/*!
@abstract Tracks this application being launched. If this happened as the result of the
/**
Tracks this application being launched. If this happened as the result of the
user opening a push notification, this method sends along information to
correlate this open with that push.

@param payload The Remote Notification payload.
@param sessionToken Current user session token.

@returns `BFTask` with result set to `@YES`.
@return `BFTask` with result set to `@YES`.
*/
- (BFTask *)trackAppOpenedEventAsyncWithRemoteNotificationPayload:(NSDictionary *)payload
sessionToken:(NSString *)sessionToken;

/*!
@abstract Tracks the occurrence of a custom event with additional dimensions.
/**
Tracks the occurrence of a custom event with additional dimensions.

@param name Event name.
@param dimensions `NSDictionary` of information by which to segment this event.
@param sessionToken Current user session token.

@returns `BFTask` with result set to `@YES`.
@return `BFTask` with result set to `@YES`.
*/
- (BFTask *)trackEventAsyncWithName:(NSString *)name
dimensions:(NSDictionary *)dimensions
Expand Down
2 changes: 1 addition & 1 deletion Parse/Internal/Analytics/PFAnalytics_Private.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

#import <Parse/PFAnalytics.h>

/*!
/**
Predefined events - AppOpened, CrashReport
Coming soon - Log, ...
*/
Expand Down
4 changes: 2 additions & 2 deletions Parse/Internal/Analytics/Utilities/PFAnalyticsUtilities.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

@interface PFAnalyticsUtilities : NSObject

/*!
/**
Serializes and hexdigests an alert payload into a "push_hash" identifier
for use in Analytics.
Limitedly flexible - the payload is the value under the "alert" key in the
Expand All @@ -21,7 +21,7 @@

@param payload `alert` value from a push notification.

@returns md5 identifier.
@return md5 identifier.
*/
+ (NSString *)md5DigestFromPushPayload:(id)payload;

Expand Down
10 changes: 5 additions & 5 deletions Parse/Internal/BFTask+Private.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,29 +36,29 @@
- (instancetype)continueWithMainThreadBooleanResultBlock:(PFBooleanResultBlock)resultBlock
executeIfCancelled:(BOOL)executeIfCancelled;

/*!
/**
Adds a continuation to the task that will run the given block on the main
thread sometime after this task has finished. If the task was cancelled,
the block will never be called. If the task had an exception, the exception
will be throw on the main thread instead of running the block. Otherwise,
the block will be given the result and error of this task.
@returns A new task that will be finished once the block has run.
@return A new task that will be finished once the block has run.
*/
- (BFTask *)thenCallBackOnMainThreadAsync:(void(^)(id result, NSError *error))block;

/*!
/**
Identical to thenCallBackOnMainThreadAsync:, except that the result of a successful
task will be converted to a BOOL using the boolValue method, and that will
be passed to the block instead of the original result.
*/
- (BFTask *)thenCallBackOnMainThreadWithBoolValueAsync:(void(^)(BOOL result, NSError *error))block;

/*!
/**
Same as `waitForResult:error withMainThreadWarning:YES`
*/
- (id)waitForResult:(NSError **)error;

/*!
/**
Waits until this operation is completed, then returns its value.
This method is inefficient and consumes a thread resource while its running.

Expand Down
4 changes: 2 additions & 2 deletions Parse/Internal/CloudCode/PFCloudCodeController.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@
/// @name Cloud Functions
///--------------------------------------

/*!
/**
Calls a Cloud Code function and returns a result of it's execution.

@param functionName Function name to call.
@param parameters Parameters to pass. (can't be nil).
@param sessionToken Session token to use.

@returns `BFTask` with a result set to a result of Cloud Function.
@return `BFTask` with a result set to a result of Cloud Function.
*/
- (BFTask *)callCloudCodeFunctionAsync:(NSString *)functionName
withParameters:(NSDictionary *)parameters
Expand Down
8 changes: 4 additions & 4 deletions Parse/Internal/Commands/CommandRunner/PFCommandRunning.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,25 +51,25 @@ NS_ASSUME_NONNULL_BEGIN
/// @name Data Commands
///--------------------------------------

/*!
/**
Run command.

@param command Command to run.
@param options Options to use to run command.

@returns `BFTask` with result set to `PFCommandResult`.
@return `BFTask` with result set to `PFCommandResult`.
*/
- (BFTask *)runCommandAsync:(PFRESTCommand *)command
withOptions:(PFCommandRunningOptions)options;

/*!
/**
Run command.

@param command Command to run.
@param options Options to use to run command.
@param cancellationToken Operation to use as a cancellation token.

@returns `BFTask` with result set to `PFCommandResult`.
@return `BFTask` with result set to `PFCommandResult`.
*/
- (BFTask *)runCommandAsync:(PFRESTCommand *)command
withOptions:(PFCommandRunningOptions)options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ NS_ASSUME_NONNULL_BEGIN

@property (nonatomic, strong, readonly) dispatch_queue_t dataQueue;

/*!
@abstract Defaults to to-memory output stream if not overwritten.
/**
Defaults to to-memory output stream if not overwritten.
*/
@property (nonatomic, strong, readonly) NSOutputStream *dataOutputStream;
@property (nonatomic, assign, readonly) uint64_t downloadedBytes;
Expand Down
2 changes: 1 addition & 1 deletion Parse/Internal/Commands/PFRESTCommand.m
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ + (BOOL)isValidDictionaryRepresentation:(NSDictionary *)dictionary {

#pragma mark Local Identifiers

/*!
/**
If this was the second save on a new object while offline, then its objectId
wasn't yet set when the command was created, so it would have been considered a
"create". But if the first save succeeded, then there is an objectId now, and it
Expand Down
4 changes: 2 additions & 2 deletions Parse/Internal/Config/Controller/PFConfigController.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@
/// @name Fetch
///--------------------------------------

/*!
/**
Fetches current config from network async.

@param sessionToken Current user session token.

@returns `BFTask` with result set to `PFConfig`.
@return `BFTask` with result set to `PFConfig`.
*/
- (BFTask *)fetchConfigAsyncWithSessionToken:(NSString *)sessionToken;

Expand Down
28 changes: 14 additions & 14 deletions Parse/Internal/FieldOperation/PFFieldOperation.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,24 @@
#pragma mark - PFFieldOperation
///--------------------------------------

/*!
/**
A PFFieldOperation represents a modification to a value in a PFObject.
For example, setting, deleting, or incrementing a value are all different
kinds of PFFieldOperations. PFFieldOperations themselves can be considered
to be immutable.
*/
@interface PFFieldOperation : NSObject

/*!
/**
Converts the PFFieldOperation to a data structure (typically an NSDictionary)
that can be converted to JSON and sent to Parse as part of a save operation.

@param objectEncoder encoder that will be used to encode the object.
@returns An object to be jsonified.
@return An object to be jsonified.
*/
- (id)encodeWithObjectEncoder:(PFEncoder *)objectEncoder;

/*!
/**
Returns a field operation that is composed of a previous operation followed by
this operation. This will not mutate either operation. However, it may return
self if the current operation is not affected by previous changes. For example:
Expand All @@ -45,11 +45,11 @@
[{delete} mergeWithPrevious:{add "foo"}] -> {delete}

@param previous The most recent operation on the field, or nil if none.
@returns A new PFFieldOperation or self.
@return A new PFFieldOperation or self.
*/
- (PFFieldOperation *)mergeWithPrevious:(PFFieldOperation *)previous;

/*!
/**
Returns a new estimated value based on a previous value and this operation. This
value is not intended to be sent to Parse, but it used locally on the client to
inspect the most likely current value for a field.
Expand All @@ -60,7 +60,7 @@
@param oldValue The previous value for the field.
@param key The key that this value is for.

@returns The new value for the field.
@return The new value for the field.
*/
- (id)applyToValue:(id)oldValue forKey:(NSString *)key;

Expand All @@ -70,7 +70,7 @@
#pragma mark - Independent Operations
///--------------------------------------

/*!
/**
An operation where a field is set to a given value regardless of
its previous value.
*/
Expand All @@ -84,7 +84,7 @@

@end

/*!
/**
An operation where a field is deleted from the object.
*/
@interface PFDeleteOperation : PFFieldOperation
Expand All @@ -97,7 +97,7 @@
#pragma mark - Numeric Operations
///--------------------------------------

/*!
/**
An operation that increases a numeric field's value by a given amount.
*/
@interface PFIncrementOperation : PFFieldOperation
Expand All @@ -114,7 +114,7 @@
#pragma mark - Array Operations
///--------------------------------------

/*!
/**
An operation that adds a new element to an array field.
*/
@interface PFAddOperation : PFFieldOperation
Expand All @@ -125,7 +125,7 @@

@end

/*!
/**
An operation that adds a new element to an array field,
only if it wasn't already present.
*/
Expand All @@ -137,7 +137,7 @@

@end

/*!
/**
An operation that removes every instance of an element from
an array field.
*/
Expand All @@ -153,7 +153,7 @@
#pragma mark - Relation Operations
///--------------------------------------

/*!
/**
An operation where a PFRelation's value is modified.
*/
@interface PFRelationOperation : PFFieldOperation
Expand Down
4 changes: 2 additions & 2 deletions Parse/Internal/FieldOperation/PFFieldOperationDecoder.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ NS_ASSUME_NONNULL_BEGIN
/// @name Decoding
///--------------------------------------

/*!
/**
Converts a parsed JSON object into a PFFieldOperation.

@param encoded An NSDictionary containing an __op field.
@returns An NSObject that conforms to PFFieldOperation.
@return An NSObject that conforms to PFFieldOperation.
*/
- (PFFieldOperation *)decode:(NSDictionary *)encoded withDecoder:(PFDecoder *)decoder;

Expand Down
10 changes: 5 additions & 5 deletions Parse/Internal/File/Controller/PFFileController.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,20 @@
/// @name Download
///--------------------------------------

/*!
/**
Downloads a file asynchronously with a given state.

@param fileState File state to download the file for.
@param cancellationToken Cancellation token.
@param progressBlock Progress block to call (optional).

@returns `BFTask` with a result set to `nil`.
@return `BFTask` with a result set to `nil`.
*/
- (BFTask *)downloadFileAsyncWithState:(PFFileState *)fileState
cancellationToken:(BFCancellationToken *)cancellationToken
progressBlock:(PFProgressBlock)progressBlock;

/*!
/**
Downloads a file asynchronously with a given state and yields a stream to the live download of that file.

@param fileState File state to download the file for.
Expand All @@ -71,7 +71,7 @@
/// @name Upload
///--------------------------------------

/*!
/**
Uploads a file asynchronously from file path for a given file state.

@param fileState File state to upload the file for.
Expand All @@ -80,7 +80,7 @@
@param cancellationToken Cancellation token.
@param progressBlock Progress block to call (optional).

@returns `BFTask` with a result set to `PFFileState` of uploaded file.
@return `BFTask` with a result set to `PFFileState` of uploaded file.
*/
- (BFTask *)uploadFileAsyncWithState:(PFFileState *)fileState
sourceFilePath:(NSString *)sourceFilePath
Expand Down
Loading