Add documentation for the drivers

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 213deb5..0c237a3 100644 (file)
--- 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 0460192..d3b69b8 100644 (file)
--- 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 8076a0e..6d212d8 100644 (file)
--- 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 db7cb4e..66c91d0 100644 (file)
--- 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);