diff options
author | José Bollo <jose.bollo@iot.bzh> | 2016-05-19 18:06:28 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2016-05-19 18:06:28 +0200 |
commit | 081733b109daa31ef57e1c3c5a0992ac9c4f9851 (patch) | |
tree | 8286a692e7b06078014d558434cd0b1e59c53e70 | |
parent | 8b9507105bb29e2b88b7c51c82ced38dca7f9e13 (diff) |
minor: documenting and cleaning
Change-Id: Ia5a84655ac7f881682409c3c6ed72e395c86a34d
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
-rw-r--r-- | include/afb/afb-plugin.h | 21 | ||||
-rw-r--r-- | plugins/CMakeLists.txt | 1 |
2 files changed, 20 insertions, 2 deletions
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 <afb/afb-req-itf.h> #include <afb/afb-event-sender-itf.h> @@ -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); diff --git a/plugins/CMakeLists.txt b/plugins/CMakeLists.txt index 21592ebf..5f830fb1 100644 --- a/plugins/CMakeLists.txt +++ b/plugins/CMakeLists.txt @@ -1,4 +1,3 @@ -#ADD_SUBDIRECTORY(afm-main-plugin) ADD_SUBDIRECTORY(session) ADD_SUBDIRECTORY(samples) ADD_SUBDIRECTORY(audio) |