doc: Improve comment on asynchronous calls

[src/app-framework-binder.git] / include / afb / afb-req-x2.h

diff --git a/include/afb/afb-req-x2.h b/include/afb/afb-req-x2.h
index 4ae1af7..5111f2f 100644 (file)
--- a/include/afb/afb-req-x2.h
+++ b/include/afb/afb-req-x2.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016, 2017, 2018 "IoT.bzh"
+ * Copyright (C) 2016-2019 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -739,6 +739,9 @@ struct json_object *afb_req_x2_get_client_info(
  *  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