afb-evt: send events in separate job

[src/app-framework-binder.git] / docs / reference-v3 / func-api.md

diff --git a/docs/reference-v3/func-api.md b/docs/reference-v3/func-api.md
index aa28932..66dd4c9 100644 (file)
--- 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
@@ -425,7 +428,7 @@ int afb_api_queue_job(
  * @param name the event name suffix
  * @param object the object that comes with the event
  *
- * @return the count of clients that received the event.
+ * @return 0 in case of success or -1 in case of error
  */
 int afb_api_broadcast_event(
                        afb_api_t api,