summaryrefslogtreecommitdiffstats
path: root/docs/reference-v3/func-api.md
diff options
context:
space:
mode:
authorJose Bollo <jose.bollo@iot.bzh>2019-02-25 11:27:48 +0100
committerJosé Bollo <jose.bollo@iot.bzh>2019-04-25 07:08:09 +0000
commit5214323d82cc09b15c25e348707f2639977ea763 (patch)
tree34254e72d126f0f238cbc366320e5738dcbf6a75 /docs/reference-v3/func-api.md
parent6401efb14339925e696a65eea8e8548f1fddf3ba (diff)
doc: Improve comment on asynchronous calls
Following the remarks of fellow developers, the status of the object received by the callback function needs to be explained better. Change-Id: I0e6bcd51849bbc5af92af08675949a901bfd683e Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs/reference-v3/func-api.md')
-rw-r--r--docs/reference-v3/func-api.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/reference-v3/func-api.md b/docs/reference-v3/func-api.md
index aa28932a..454bc0f6 100644
--- a/docs/reference-v3/func-api.md
+++ b/docs/reference-v3/func-api.md
@@ -293,6 +293,9 @@ struct json_object *afb_api_settings(
* 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