Add documention for the elements
authorMarcel Holtmann <marcel@holtmann.org>
Thu, 14 Aug 2008 05:39:50 +0000 (07:39 +0200)
committerMarcel Holtmann <marcel@holtmann.org>
Thu, 14 Aug 2008 05:39:50 +0000 (07:39 +0200)
doc/Makefile.am
doc/connman-docs.xml
include/element.h
include/property.h

index 0c237a3..9b5367a 100644 (file)
@@ -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
+IGNORE_HFILES = connman connman.h rtnl.h dbus.h iface.h
 
 HTML_IMAGES =
 
index d3b69b8..29bc853 100644 (file)
@@ -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/element.xml" />
     <xi:include href="xml/driver.xml" />
   </reference>
 
index 9b8beab..e2d7ea8 100644 (file)
@@ -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,
index 20d525a..d343948 100644 (file)
 extern "C" {
 #endif
 
+/**
+ * SECTION:property
+ * @title: Property premitives
+ * @short_description: Functions for handling properties
+ */
+
 enum connman_property_type {
        CONNMAN_PROPERTY_TYPE_INVALID = 0,