summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/plugin-api.txt22
2 files changed, 23 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 04bffe2b..3155148a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -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
index 00000000..f8dded07
--- /dev/null
+++ b/doc/plugin-api.txt
@@ -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)