Skip to content

Commit

Permalink
Merge pull request #220 from keenlabs/fix_documentation_warnings
Browse files Browse the repository at this point in the history
Fix documentation warnings.
  • Loading branch information
baumatron committed May 15, 2017
2 parents 6a83fe0 + a6ade21 commit 6ddc34a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
3 changes: 2 additions & 1 deletion KeenClient/KIODBStore.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
Add an event to the store.
@param eventData Your event data.
@param coll Your event collection.
@param eventCollection Your event collection.
@param projectID Project ID to add the event to.
*/
- (BOOL)addEvent:(NSData *)eventData collection:(NSString *)eventCollection projectID:(NSString *)projectID;

Expand Down
2 changes: 1 addition & 1 deletion KeenClient/KIOUploader.m
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ - (void)runUploadFinishedBlock:(void (^)())block;
and then removing any events from the local filesystem that have been handled by the keen API.
@param response The response from the server.
@param responseData The data returned from the server.
@param eventPaths A dictionary that maps events to their paths on the file system.
@param eventIds A dictionary that maps events to their ID's in the local store.
*/
- (void)handleEventAPIResponse:(NSURLResponse *)response
andData:(NSData *)responseData
Expand Down
8 changes: 3 additions & 5 deletions KeenClient/KeenClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ typedef NSDictionary* (^KeenGlobalPropertiesBlock)(NSString *eventCollection);
@return An instance of KIOEventStore.
*/
+ (KIODBStore *)getDBStore DEPRECATED_MSG_ATTRIBUTE("Class method getDBStore is deprecated. User instance method instead.");
+ (KIODBStore *)getDBStore DEPRECATED_MSG_ATTRIBUTE("Class method getDBStore is deprecated. Use instance method instead.");
- (KIODBStore *)getDBStore;

/**
Expand Down Expand Up @@ -320,8 +320,7 @@ typedef NSDictionary* (^KeenGlobalPropertiesBlock)(NSString *eventCollection);
This method is only used for testing.
@param keenQuery The KIOQuery object containing the information about the query.
@param returningResponse The NSURLResponse for the query.
@param error The NSError (if any) for the query.
@param completionHandler The block to call upon completion of the query.
*/
- (void)runQuery:(KIOQuery *)keenQuery completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler;

Expand All @@ -331,8 +330,7 @@ typedef NSDictionary* (^KeenGlobalPropertiesBlock)(NSString *eventCollection);
This method is only used for testing.
@param keenQueries The NSArray object containing multiple KIOQuery objects. They must all contain the same value for the event_collection property.
@param returningResponse The NSURLResponse for the query.
@param error The NSError (if any) for the query.
@param completionHandler The block to call upon completion of the query.
*/
- (void)runMultiAnalysisWithQueries:(NSArray *)keenQueries completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler;

Expand Down

0 comments on commit 6ddc34a

Please sign in to comment.