From c9bb1cec405741d5721dfcafb35b187c6f182a6f Mon Sep 17 00:00:00 2001
From: José Bollo <jose.bollo@iot.bzh>
Date: Mon, 19 Sep 2016 10:54:42 +0200
Subject: Documentation: improvements
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- improves formatting of the documentation on events
- add documentations of functions in headers

Change-Id: Ie39d34fca8bd563a099f6b575c72e314ca08a29d
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
---
 include/afb/afb-binding.h     | 17 ++++++++++++++++
 include/afb/afb-service-itf.h | 46 ++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 62 insertions(+), 1 deletion(-)

(limited to 'include')

diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h
index 7d5da112..43075df1 100644
--- a/include/afb/afb-binding.h
+++ b/include/afb/afb-binding.h
@@ -172,6 +172,23 @@ struct afb_binding_interface
 
 /*
  * Function for registering the binding
+ *
+ * A binding V1 MUST have a function of this name and signature.
+ * This function is called during loading of the binding. It
+ * receives an 'interface' that should be recorded for later access to
+ * functions provided by the framework.
+ *
+ * This function MUST return the address of a structure that describes
+ * the binding and its implemented verbs.
+ *
+ * In case of initialisation error, NULL must be returned.
+ *
+ * Be aware that the given 'interface' is not fully functionnal
+ * because no provision is given to the name and description
+ * of the binding. Check the function 'afbBindingV1ServiceInit'
+ * defined in the file <afb/afb-service-itf.h> because when
+ * the function 'afbBindingV1ServiceInit' is called, the 'interface'
+ * is fully functionnal.
  */
 extern const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *interface);
 
diff --git a/include/afb/afb-service-itf.h b/include/afb/afb-service-itf.h
index 1218cd5b..9b7ae739 100644
--- a/include/afb/afb-service-itf.h
+++ b/include/afb/afb-service-itf.h
@@ -20,22 +20,66 @@
 /* avoid inclusion of <json-c/json.h> */
 struct json_object;
 
+/*
+ * Interface for internal of services
+ * It records the functions to be called for the request.
+ * Don't use this structure directly.
+ * Use the helper functions documented below.
+ */
 struct afb_service_itf
 {
+	/* CAUTION: respect the order, add at the end */
+
 	void (*call)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *callback_closure);
 };
 
+/*
+ * Object that encapsulate accesses to service items
+ */
 struct afb_service
 {
 	const struct afb_service_itf *itf;
 	void *closure;
 };
 
+/*
+ * When a binding have an exported implementation of the
+ * function 'afbBindingV1ServiceInit', defined below,
+ * the framework calls it for initialising the service after
+ * registration of all bindings.
+ *
+ * The object 'service' should be recorded. It has functions that
+ * allows the binding to call features with its own personality.
+ *
+ * The function should return 0 in case of success or, else, should return
+ * a negative value.
+ */
 extern int afbBindingV1ServiceInit(struct afb_service service);
 
+/*
+ * When a binding have an implementation of the function 'afbBindingV1ServiceEvent',
+ * defined below, the framework calls that function for any broadcasted event or for
+ * events that the service subscribed to in its name.
+ *
+ * It receive the 'event' name and its related data in 'object' (be aware that 'object'
+ * might be NULL).
+ */
 extern void afbBindingV1ServiceEvent(const char *event, struct json_object *object);
 
-static inline void afb_service_call(struct afb_service service, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *callback_closure)
+/*
+ * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
+ * The result of the call is delivered to the 'callback' function with the 'callback_closure'.
+ *
+ * The 'callcack' receives 3 arguments:
+ *  1. 'closure' the user defined closure pointer 'callback_closure',
+ *  2. 'iserror' a boolean status being true (not null) when an error occured,
+ *  2. 'result' the resulting data as a JSON object.
+ *
+ * See also 'afb_req_subcall'
+ *
+ * Returns 0in case of success or -1 in case of error.
+ */
+static inline void afb_service_call(struct afb_service service, const char *api, const char *verb, struct json_object *args, void (*callback)(void*closure, int iserror, struct json_object *result), void *callback_closure)
 {
 	service.itf->call(service.closure, api, verb, args, callback, callback_closure);
 }
-- 
cgit 1.2.3-korg