diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-08-14 07:25:31 +0200 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-08-14 07:25:31 +0200 |
| commit | 164a8db64e48e0b00730c5830b9a7f8293dcf613 (patch) | |
| tree | 6b84657017e68c5220035ea5bff8f4e405e78a22 | |
| parent | 95957bba963cd329416420e3dedc3d0969c3ee9d (diff) | |
| download | connman-164a8db64e48e0b00730c5830b9a7f8293dcf613.tar.gz connman-164a8db64e48e0b00730c5830b9a7f8293dcf613.tar.bz2 connman-164a8db64e48e0b00730c5830b9a7f8293dcf613.zip | |
Add documentation for the drivers
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/connman-docs.xml | 1 | ||||
| -rw-r--r-- | include/driver.h | 6 | ||||
| -rw-r--r-- | src/element.c | 14 |
4 files changed, 22 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 213deb54..0c237a30 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 + iface.h rtnl.h dbus.h element.h property.h HTML_IMAGES = diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml index 0460192c..d3b69b8f 100644 --- a/doc/connman-docs.xml +++ b/doc/connman-docs.xml @@ -67,6 +67,7 @@ <xi:include href="xml/log.xml" /> <xi:include href="xml/plugin.xml" /> <xi:include href="xml/security.xml" /> + <xi:include href="xml/driver.xml" /> </reference> <appendix id="license"> diff --git a/include/driver.h b/include/driver.h index 8076a0e0..6d212d8f 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/src/element.c b/src/element.c index db7cb4e7..66c91d0b 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); |