Add ability to provide binding settings

[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 2f836ca..ef3816d 100644 (file)
--- a/docs/reference-v3/func-api.md
+++ b/docs/reference-v3/func-api.md
@@ -58,7 +58,7 @@ void afb_api_set_userdata(
  * Check that it requires the API of 'name'.
  * If 'initialized' is not zero it requests the API to be
  * initialized, implying its initialization if needed.
- * 
+ *
  * Calling this function is only allowed within init.
  *
  * A single request allows to require multiple apis.
@@ -255,6 +255,24 @@ int afb_api_rootdir_open_locale(
                        const char *locale);
 ```
 
+### afb_api_settings
+
+```C
+/**
+ * Settings of the api.
+ *
+ * Get the settings of the API. The settings are recorded
+ * as a JSON object. The returned object should not be modified.
+ * It MUST NOT be released using json_object_put.
+ *
+ * @param api the api whose settings are required
+ *
+ * @returns The setting object.
+ */
+struct json_object *afb_api_settings(
+                       struct afb_api_x3 *api);
+```
+
 ## Calls and job functions
 
 ### afb_api_call
@@ -579,9 +597,9 @@ struct sd_bus *afb_api_get_system_bus(
  * @param info the brief description of the new api (can be NULL)
  * @param noconcurrency zero or not zero whether the new api is reentrant or not
  * @param preinit the pre-initialization function if any (can be NULL)
- * @param closure the closure for the pre-initialization \ref preinit
+ * @param closure the closure for the pre-initialization preinit
  *
- * @return 0 in case of success or -1 on failure with errno set
+ * @return the created api in case of success or NULL on error
  *
  * @see afb_api_delete_api
  */