From: Marcel Holtmann <marcel@holtmann.org>
Date: Thu, 14 Aug 2008 04:57:45 +0000 (+0200)
Subject: Add documentation for the security framework
X-Git-Tag: 2.0_alpha~4724
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=95957bba963cd329416420e3dedc3d0969c3ee9d;p=framework%2Fconnectivity%2Fconnman.git

Add documentation for the security framework
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index a2e9205..213deb5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -18,7 +18,7 @@ HFILE_GLOB = $(top_srcdir)/include/*.h
 CFILE_GLOB = $(top_srcdir)/src/*.c $(top_srcdir)/src/*.h
 
 IGNORE_HFILES = connman connman.h supplicant.h \
-		iface.h rtnl.h dbus.h element.h property.h driver.h security.h
+		iface.h rtnl.h dbus.h element.h property.h driver.h
 
 HTML_IMAGES =
 
diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml
index 4674a62..0460192 100644
--- a/doc/connman-docs.xml
+++ b/doc/connman-docs.xml
@@ -66,6 +66,7 @@
     </partintro>
     <xi:include href="xml/log.xml" />
     <xi:include href="xml/plugin.xml" />
+    <xi:include href="xml/security.xml" />
   </reference>
 
   <appendix id="license">
diff --git a/include/security.h b/include/security.h
index 104ca7c..895464a 100644
--- a/include/security.h
+++ b/include/security.h
@@ -28,6 +28,12 @@ extern "C" {
 
 #include <connman/element.h>
 
+/**
+ * SECTION:security
+ * @title: Security premitives
+ * @short_description: Functions for registering security modules
+ */
+
 #define CONNMAN_SECURITY_PRIORITY_LOW      -100
 #define CONNMAN_SECURITY_PRIORITY_DEFAULT     0
 #define CONNMAN_SECURITY_PRIORITY_HIGH      100
diff --git a/src/security.c b/src/security.c
index f81fc46..0576650 100644
--- a/src/security.c
+++ b/src/security.c
@@ -36,6 +36,14 @@ static gint compare_priority(gconstpointer a, gconstpointer b)
 	return security2->priority - security1->priority;
 }
 
+/**
+ * connman_security_register:
+ * @security: security module
+ *
+ * Register a new security module
+ *
+ * Returns: %0 on success
+ */
 int connman_security_register(struct connman_security *security)
 {
 	DBG("security %p name %s", security, security->name);
@@ -50,6 +58,12 @@ int connman_security_register(struct connman_security *security)
 	return 0;
 }
 
+/**
+ * connman_security_unregister:
+ * @security: security module
+ *
+ * Remove a previously registered security module
+ */
 void connman_security_unregister(struct connman_security *security)
 {
 	DBG("security %p name %s", security, security->name);