diff options
author | Jose Bollo <jose.bollo@iot.bzh> | 2019-02-25 11:27:48 +0100 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2019-03-22 12:21:54 +0100 |
commit | 64ca02ceed8acd4b55e423de6b586a143f5a3c64 (patch) | |
tree | d89a9e9e8738e0368f50511b182868471e3115ae /docs/reference-v3/func-api.md | |
parent | 0e2b5f5b7fa3a09abf61c8253efce7c7f2b4c444 (diff) |
doc: Improve comment on asynchronous calls
Following remarks of fellow developpers, the status
the object received by the callback function
needed to be more explained.
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.md | 3 |
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 |