doc: Improve comment on asynchronous calls
[src/app-framework-binder.git] / docs / reference-v3 / func-req.md
index bdec581..a91508d 100644 (file)
@@ -1,4 +1,4 @@
-Functions of class afb_req_t
+Functions of class **afb_req_t**
 ============================
 
 ## General function
@@ -436,6 +436,9 @@ void afb_req_reply_f(
  *  4. 'info'    a string handling some info (can be NULL)
  *  5. 'req'     the req
  *
+ * 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 req      The request
  * @param api      The api name of the method to call
  * @param verb     The verb name of the method to call
@@ -805,7 +808,7 @@ void afb_req_subcall_legacy(
  *
  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
  * This call is made in the context of the request 'req'.
- * This call is synchronous, it waits untill completion of the request.
+ * This call is synchronous, it waits until completion of the request.
  * It returns 0 on success or a negative value on error answer.
  * The object pointed by 'result' is filled and must be released by the caller
  * after its use by calling 'json_object_put'.