Skip to content

Commit

Permalink
Fixed doc comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen Cobbe committed Sep 27, 2016
1 parent 3d9dca1 commit d8c8b61
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@
///
- (nonnull instancetype)init:(NSURL * _Nonnull)url
tryInterceptHandler:(BOOL (^_Nonnull)(NSURL * _Nonnull))tryInterceptHandler
cancelHandler:(void (^_Nonnull)(void))cancel;
cancelHandler:(void (^_Nonnull)(void))cancelHandler;

@end
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@
///
- (nonnull instancetype)init:(NSURL * _Nonnull)url
tryInterceptHandler:(BOOL (^_Nonnull)(NSURL * _Nonnull))tryInterceptHandler
cancelHandler:(void (^_Nonnull)(void))cancel;
cancelHandler:(void (^_Nonnull)(void))cancelHandler;

@end
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
/// Convenience constructor.
///
/// @param accessToken The Dropbox OAuth2 access token used to make requests.
/// @param memberId The Dropbox account_id of the team member to perform actions on
/// @param selectUser The Dropbox account_id of the team member to perform actions on
/// behalf of. e.g. "dbid:12345678910..."
///
/// @return An initialized instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@
///
/// @param task The `NSURLSessionTask` task associated with the API request.
/// @param session The `NSURLSession` session associated with the API request.
/// @param progressHandler The progress block to be executed in the event of a request update.
/// @param handler The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes downloaded. The second argument is the number of total
/// bytes downloaded. And the third argument is the number of total bytes expected to be downloaded.
/// @param progressHandlerQueue The operation queue on which to execute progress handler code. If nil,
/// @param handlerQueue The operation queue on which to execute progress handler code. If nil,
/// then the progress queue is the queue with which the delegate object was instantiated.
///
- (void)addProgressHandler:(NSURLSessionTask * _Nonnull)task
Expand All @@ -70,9 +70,9 @@
///
/// @param task The `NSURLSessionTask` task associated with the API request.
/// @param session The `NSURLSession` session associated with the API request.
/// @param responseHandler The handler block to be executed in the event of a successful or
/// @param handler The handler block to be executed in the event of a successful or
/// unsuccessful network request.
/// @param responseHandlerQueue The operation queue on which to execute response handler code. If nil,
/// @param handlerQueue The operation queue on which to execute response handler code. If nil,
/// then the response queue is the queue with which the delegate object was instantiated.
///
- (void)addRpcResponseHandler:(NSURLSessionTask * _Nonnull)task
Expand All @@ -88,9 +88,9 @@
///
/// @param task The `NSURLSessionTask` task associated with the API request.
/// @param session The `NSURLSession` session associated with the API request.
/// @param responseHandler The handler block to be executed in the event of a successful or
/// @param handler The handler block to be executed in the event of a successful or
/// unsuccessful network request.
/// @param responseHandlerQueue The operation queue on which to execute response handler code. If nil,
/// @param handlerQueue The operation queue on which to execute response handler code. If nil,
/// then the response queue is the queue with which the delegate object was instantiated.
///
- (void)addUploadResponseHandler:(NSURLSessionTask * _Nonnull)task
Expand All @@ -106,9 +106,9 @@
///
/// @param task The `NSURLSessionTask` task associated with the API request.
/// @param session The `NSURLSession` session associated with the API request.
/// @param responseHandler The handler block to be executed in the event of a successful or
/// @param handler The handler block to be executed in the event of a successful or
/// unsuccessful network request.
/// @param responseHandlerQueue The operation queue on which to execute response handler code. If nil,
/// @param handlerQueue The operation queue on which to execute response handler code. If nil,
/// then the response queue is the queue with which the delegate object was instantiated.
///
- (void)addDownloadResponseHandler:(NSURLSessionTask * _Nonnull)task
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@
/// @param task The `NSURLSessionDataTask` task that initialized the network request.
/// @param session The `NSURLSession` used to make the network request.
/// @param delegate The delegate that manages and executes response code.
/// @param backgroundSessionId The background session identifier used to make background request
/// @param route The static `DBRoute` instance associated with the route to which the request
/// was made. Contains information like route host, response type, etc.). This is used in the deserialization
/// process.
Expand All @@ -92,7 +91,7 @@
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.).
Expand All @@ -110,7 +109,7 @@
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.).
Expand All @@ -128,7 +127,7 @@
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes sent. The second argument is the number of total
/// bytes sent. And the third argument is the number of total bytes expected to be sent.
///
Expand All @@ -144,7 +143,7 @@
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes sent. The second argument is the number of total
/// bytes sent. And the third argument is the number of total bytes expected to be sent.
///
Expand Down Expand Up @@ -194,7 +193,6 @@
/// @param task The `NSURLSessionDataTask` task that initialized the network request.
/// @param session The `NSURLSession` used to make the network request.
/// @param delegate The delegate that manages and executes response code.
/// @param backgroundSessionId The background session identifier used to make background request
/// @param route The static `DBRoute` instance associated with the route to which the request
/// was made. Contains information like route host, response type, etc.). This is used in the deserialization
/// process.
Expand All @@ -213,7 +211,7 @@
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.).
Expand All @@ -231,7 +229,7 @@
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.).
Expand All @@ -249,7 +247,7 @@
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes uploaded. The second argument is the number of total
/// bytes uploaded. And the third argument is the number of total bytes expected to be uploaded.
///
Expand All @@ -265,7 +263,7 @@
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes uploaded. The second argument is the number of total
/// bytes uploaded. And the third argument is the number of total bytes expected to be uploaded.
///
Expand Down Expand Up @@ -322,7 +320,6 @@
/// @param task The `NSURLSessionDataTask` task that initialized the network request.
/// @param session The `NSURLSession` used to make the network request.
/// @param delegate The delegate that manages and executes response code.
/// @param backgroundSessionId The background session identifier used to make background request
/// @param route The static `DBRoute` instance associated with the route to which the request
/// was made. Contains information like route host, response type, etc.). This is used in the deserialization
/// process.
Expand All @@ -348,7 +345,7 @@
/// location (`NSTemporaryDirectory()`) until the response handler is installed, at which point the
/// file content will be moved to its final destination.
///
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.). The fourth
Expand All @@ -367,7 +364,7 @@
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.). The fourth
Expand All @@ -386,7 +383,7 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes downloaded. The second argument is the number of total
/// bytes downloaded. And the third argument is the number of total bytes expected to be downloaded.
///
Expand All @@ -402,7 +399,7 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes downloaded. The second argument is the number of total
/// bytes downloaded. And the third argument is the number of total bytes expected to be downloaded.
///
Expand Down Expand Up @@ -454,7 +451,6 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
/// @param task The `NSURLSessionDataTask` task that initialized the network request.
/// @param session The `NSURLSession` used to make the network request.
/// @param delegate The delegate that manages and executes response code.
/// @param backgroundSessionId The background session identifier used to make background request
/// @param route The static `DBRoute` instance associated with the route to which the request
/// was made. Contains information like route host, response type, etc.). This is used in the deserialization
/// process.
Expand All @@ -473,7 +469,7 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.). The fourth
Expand All @@ -492,7 +488,7 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param response The handler block to be executed in the event of a successful or
/// @param responseBlock The handler block to be executed in the event of a successful or
/// unsuccessful network request. The first argument is the route-specific result. The second
/// argument is the route-specific error. And the third argument is the more general network
/// error (which includes information like Dropbox request ID, http status code, etc.). The fourth
Expand All @@ -511,7 +507,7 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
///
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes downloaded. The second argument is the number of total
/// bytes downloaded. And the third argument is the number of total bytes expected to be downloaded.
///
Expand All @@ -527,7 +523,7 @@ response:(void (^_Nonnull)(TResponse _Nullable, TError _Nullable, DBError * _Nul
/// @note Any existing handlers are replaced by the supplied handler.
///
/// @param queue The operation queue on which to execute the response.
/// @param progress The progress block to be executed in the event of a request update.
/// @param progressBlock The progress block to be executed in the event of a request update.
/// The first argument is the number of bytes downloaded. The second argument is the number of total
/// bytes downloaded. And the third argument is the number of total bytes expected to be downloaded.
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ - (DBError *)getDBError:(NSData *)errorData
if (clientError) {
return [[DBError alloc] initAsClientError:clientError];
}

if (statusCode == 200) {
return nil;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,13 +157,13 @@
#pragma mark - Upload-style request (NSURL)

///
/// Request to Upload-style endpoint (via NSURL).
/// Request to Upload-style endpoint (via `NSURL`).
///
/// @param route The static `DBRoute` instance associated with the route. Contains information
/// like route host, response type, etc.
/// @param arg The unserialized route argument to pass. Must conform to the `DBSerializable`
/// protocol.
/// @param inputUrl The location of the file to upload. NSURLSession supports background uploads
/// @param input The location of the file to upload. NSURLSession supports background uploads
/// for this input type, so by default, all requests of this type will be made in the background.
///
/// @return A `DBUploadTask` where response and progress handlers can be added, and the request can
Expand All @@ -182,7 +182,7 @@
/// like route host, response type, etc.
/// @param arg The unserialized route argument to pass. Must conform to the `DBSerializable`
/// protocol.
/// @param inputUrl The location of the file to upload. NSURLSession does not support background
/// @param input The location of the file to upload. NSURLSession does not support background
/// uploads for this input type, so by default, all requests of this type will be made in the foreground.
///
/// @return A `DBUploadTask` where response and progress handlers can be added, and the request can
Expand All @@ -201,7 +201,7 @@
/// like route host, response type, etc.
/// @param arg The unserialized route argument to pass. Must conform to the `DBSerializable`
/// protocol.
/// @param inputUrl The location of the file to upload. `NSURLSession` does not support background
/// @param input The location of the file to upload. `NSURLSession` does not support background
/// uploads for this input type, so by default, all requests of this type will be made in the foreground.
///
/// @return A `DBUploadTask` where response and progress handlers can be added, and the request can
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
///
/// Saves an access token to the `DBKeychain` class.
///
/// @param token The access token to save.
/// @param accessToken The access token to save.
///
/// @return Whether the save operation succeeded.
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/// Class method which returns a json-compatible dictionary representation of the
/// supplied object.
///
/// @param instance: An instance of the API object to be serialized.
/// @param instance An instance of the API object to be serialized.
///
/// @return A serialized, json-compatible dictionary representation of the API object.
///
Expand All @@ -24,7 +24,7 @@
/// Class method which returns an instantiation of the supplied object as represented
/// by a json-compatible dictionary.
///
/// @param dict: A dictionary representation of the API object to be serialized.
/// @param dict A dictionary representation of the API object to be serialized.
///
/// @return A deserialized, instantiation of the API object.
///
Expand Down

0 comments on commit d8c8b61

Please sign in to comment.