Add first draft of plugin API description
authorMarcel Holtmann <marcel@holtmann.org>
Sat, 1 Mar 2008 07:33:54 +0000 (08:33 +0100)
committerMarcel Holtmann <marcel@holtmann.org>
Sat, 1 Mar 2008 07:33:54 +0000 (08:33 +0100)
doc/Makefile.am
doc/plugin-api.txt [new file with mode: 0644]

index 04bffe2..3155148 100644 (file)
@@ -1,4 +1,4 @@
 
-EXTRA_DIST = manager-api.txt interface-api.txt agent-api.txt
+EXTRA_DIST = manager-api.txt interface-api.txt agent-api.txt plugin-api.txt
 
 MAINTAINERCLEANFILES = Makefile.in
diff --git a/doc/plugin-api.txt b/doc/plugin-api.txt
new file mode 100644 (file)
index 0000000..f8dded0
--- /dev/null
@@ -0,0 +1,22 @@
+Plugin programming interface
+****************************
+
+Plugin basics
+=============
+The Connection Manager supports plugins for various actions. The basic plugin
+contains of plugin description via CONNMAN_PLUGIN_DEFINE and also init/exit
+callbacks definied through that description.
+
+#include <connman/plugin.h>
+
+static int example_init(void)
+{
+       return 0;
+}
+
+static void example_exit(void)
+{
+}
+
+CONNMAN_PLUGIN_DEFINE("example", "Example plugin", VERSION,
+                                               example_init, example_exit)