Permalink
Browse files

added function docs

  • Loading branch information...
1 parent 03a7877 commit ea04745fc53461027845bc82dce77cf3e9406b1d @ettore committed Mar 16, 2013
Showing with 6 additions and 1 deletion.
  1. +6 −1 clcg_addressbook_utils.h
View
@@ -38,7 +38,12 @@ extern "C" {
typedef void (^CLCGABCallback)(NSMutableArray *people, BOOL granted, NSError *err);
-void clcg_addressbook_load_contacts(CLCGABCallback callback);
+ /*!
+ Load contacts from the device's address book and returns them via a callback.
+ The callback itself is called on the same thread this function is being
+ called on. (To ensure ABAddressBook thread-safety.)
+ */
+ void clcg_addressbook_load_contacts(CLCGABCallback callback);
#ifdef __cplusplus
}

0 comments on commit ea04745

Please sign in to comment.