This email list is read-only. Emails sent to this list will be discarded
----------------------------------
doc/Makefile.am | 3 +--
doc/connman-docs.xml | 3 +++
include/driver.h | 6 ++++++
include/element.h | 6 ++++++
include/property.h | 6 ++++++
include/security.h | 6 ++++++
src/element.c | 14 ++++++++++++++
src/security.c | 14 ++++++++++++++
8 files changed, 56 insertions(+), 2 deletions(-)
New commits:
commit 550cd253b4bf3197ac4e00f0f213fca391d4622f
Author: Marcel Holtmann <[EMAIL PROTECTED]>
Date: Thu Aug 14 07:39:50 2008 +0200
Add documention for the elements
commit 164a8db64e48e0b00730c5830b9a7f8293dcf613
Author: Marcel Holtmann <[EMAIL PROTECTED]>
Date: Thu Aug 14 07:25:31 2008 +0200
Add documentation for the drivers
commit 95957bba963cd329416420e3dedc3d0969c3ee9d
Author: Marcel Holtmann <[EMAIL PROTECTED]>
Date: Thu Aug 14 06:57:45 2008 +0200
Add documentation for the security framework
Diff in this email is a maximum of 400 lines.
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a2e9205..9b5367a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -17,8 +17,7 @@ MKTMPL_OPTIONS = --output-dir=.
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
+IGNORE_HFILES = connman connman.h rtnl.h dbus.h iface.h
HTML_IMAGES =
diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml
index 4674a62..29bc853 100644
--- a/doc/connman-docs.xml
+++ b/doc/connman-docs.xml
@@ -66,6 +66,9 @@
</partintro>
<xi:include href="xml/log.xml" />
<xi:include href="xml/plugin.xml" />
+ <xi:include href="xml/security.xml" />
+ <xi:include href="xml/element.xml" />
+ <xi:include href="xml/driver.xml" />
</reference>
<appendix id="license">
diff --git a/include/driver.h b/include/driver.h
index 8076a0e..6d212d8 100644
--- a/include/driver.h
+++ b/include/driver.h
@@ -28,6 +28,12 @@ extern "C" {
#include <connman/element.h>
+/**
+ * SECTION:driver
+ * @title: Driver premitives
+ * @short_description: Functions for registering drivers
+ */
+
#define CONNMAN_DRIVER_PRIORITY_LOW -100
#define CONNMAN_DRIVER_PRIORITY_DEFAULT 0
#define CONNMAN_DRIVER_PRIORITY_HIGH 100
diff --git a/include/element.h b/include/element.h
index 9b8beab..e2d7ea8 100644
--- a/include/element.h
+++ b/include/element.h
@@ -31,6 +31,12 @@ extern "C" {
#include <connman/property.h>
+/**
+ * SECTION:element
+ * @title: Element premitives
+ * @short_description: Functions for handling elements
+ */
+
enum connman_element_state {
CONNMAN_ELEMENT_STATE_UNKNOWN = 0,
CONNMAN_ELEMENT_STATE_CONNECT = 1,
diff --git a/include/property.h b/include/property.h
index 20d525a..d343948 100644
--- a/include/property.h
+++ b/include/property.h
@@ -26,6 +26,12 @@
extern "C" {
#endif
+/**
+ * SECTION:property
+ * @title: Property premitives
+ * @short_description: Functions for handling properties
+ */
+
enum connman_property_type {
CONNMAN_PROPERTY_TYPE_INVALID = 0,
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/element.c b/src/element.c
index db7cb4e..66c91d0 100644
--- a/src/element.c
+++ b/src/element.c
@@ -363,6 +363,14 @@ static gboolean probe_driver(GNode *node, gpointer data)
return FALSE;
}
+/**
+ * connman_driver_register:
+ * @driver: driver definition
+ *
+ * Register a new driver
+ *
+ * Returns: %0 on success
+ */
int connman_driver_register(struct connman_driver *driver)
{
DBG("driver %p name %s", driver, driver->name);
@@ -406,6 +414,12 @@ static gboolean remove_driver(GNode *node, gpointer data)
return FALSE;
}
+/**
+ * connman_driver_unregister:
+ * @driver: driver definition
+ *
+ * Remove a previously registered driver
+ */
void connman_driver_unregister(struct connman_driver *driver)
{
DBG("driver %p name %s", driver, driver->name);
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);
_______________________________________________
Commits mailing list
[email protected]
https://www.moblin.org/mailman/listinfo/commits
