From: Marcel Holtmann <marcel@holtmann.org>
Date: Sat, 1 Mar 2008 07:33:54 +0000 (+0100)
Subject: Add first draft of plugin API description
X-Git-Tag: 0.1~382
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=957896b6bbeae6dc4efef26da8bfe48fece916ca;p=platform%2Fupstream%2Fconnman.git

Add first draft of plugin API description
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 04bffe2..3155148 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 0000000..f8dded0
--- /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)