From 081733b109daa31ef57e1c3c5a0992ac9c4f9851 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Thu, 19 May 2016 18:06:28 +0200 Subject: minor: documenting and cleaning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ia5a84655ac7f881682409c3c6ed72e395c86a34d Signed-off-by: José Bollo --- include/afb/afb-plugin.h | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'include/afb/afb-plugin.h') diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index de1ab419..c457f853 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -17,6 +17,25 @@ #pragma once +/***************************************************************************** + * This files is the main file to include for writing plugins dedicated to + * + * AFB-DAEMON + * + * Functions of plugins of afb-daemon are accessible by authorized clients + * through the apis module of afb-daemon. + * + * A plugin is a shared library. This shared library must have at least one + * exported symbol for being registered in afb-daemon. + * For the current version of afb-daemon, the function exported MUST be named + * + * pluginAfbV1Register + */ + +/* + * Some function of the library are exported to afb-daemon. + */ + #include #include @@ -119,7 +138,7 @@ struct AFB_interface }; /* - * The function for registering the plugin to AFB + * Function for registering the plugin */ extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *interface); -- cgit 1.2.3-korg