doc: Improve comment on asynchronous calls
[src/app-framework-binder.git] / include / afb / afb-api-x3.h
index fc72d07..ca92bb5 100644 (file)
@@ -814,6 +814,9 @@ int afb_api_x3_event_handler_del(
  *  4. 'info'    a string handling some info (can be NULL)
  *  5. 'api'     the api
  *
+ * NOTE: For convenience, *json_object_put* is called on 'object' after the
+ * callback returns. So, it is wrong to call *json_object_put* in the callback.
+ *
  * @param api      The api that makes the call
  * @param apiname  The api name of the method to call
  * @param verb     The verb name of the method to call
@@ -821,7 +824,6 @@ int afb_api_x3_event_handler_del(
  * @param callback The to call on completion
  * @param closure  The closure to pass to the callback
  *
- *
  * @see afb_req_subcall
  * @see afb_req_subcall_sync
  * @see afb_api_x3_call_sync