X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-binding.h;h=43075df1c6502a64403621dc78f497ee1f5a8cdb;hb=3066dda4e4e4be70335ca2dfbc74a20f4ff0dede;hp=7d5da112e4b6a21c90a9d23d3016c5359bf1d754;hpb=7c7d610ccbd7e30204501622ebee6690aef5af0c;p=src%2Fapp-framework-binder.git

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);