GNOME.org
 

[liboobs] Make gtk-doc fully dynamic and clean it

commit 42bb9e0a938a9af2b2e95ccc75466756243ba49b
Author: Milan Bouchet-Valat <nalimilan club fr>
Date:   Sat Sep 5 14:11:48 2009 +0200

    Make gtk-doc fully dynamic and clean it
    
    Move sections to inlined comments instead of static liboobs-sections.txt. Update Makefile.am, bump required version in configure.in to 1.9. Remove all static files now useless. Remove two absent interfaces from liboobs-docs.sgml.

 configure.in                                |    2 +-
 doc/reference/Makefile.am                   |   25 +-
 doc/reference/liboobs-docs.sgml             |    6 +-
 doc/reference/liboobs-sections.txt          |  616 ---------------------------
 doc/reference/liboobs.types                 |   27 --
 doc/reference/tmpl/liboobs-unused.sgml      |  529 -----------------------
 doc/reference/tmpl/oobs-group.sgml          |  126 ------
 doc/reference/tmpl/oobs-groupsconfig.sgml   |   52 ---
 doc/reference/tmpl/oobs-hostsconfig.sgml    |  115 -----
 doc/reference/tmpl/oobs-iface-ethernet.sgml |  163 -------
 doc/reference/tmpl/oobs-iface-irlan.sgml    |   25 --
 doc/reference/tmpl/oobs-iface-isdn.sgml     |   19 -
 doc/reference/tmpl/oobs-iface-modem.sgml    |   51 ---
 doc/reference/tmpl/oobs-iface-plip.sgml     |   71 ---
 doc/reference/tmpl/oobs-iface-wireless.sgml |   94 ----
 doc/reference/tmpl/oobs-iface.sgml          |  124 ------
 doc/reference/tmpl/oobs-ifacesconfig.sgml   |   79 ----
 doc/reference/tmpl/oobs-list.sgml           |  171 --------
 doc/reference/tmpl/oobs-nfsconfig.sgml      |   42 --
 doc/reference/tmpl/oobs-ntpconfig.sgml      |   42 --
 doc/reference/tmpl/oobs-ntpserver.sgml      |   53 ---
 doc/reference/tmpl/oobs-object.sgml         |  109 -----
 doc/reference/tmpl/oobs-service.sgml        |   70 ---
 doc/reference/tmpl/oobs-servicesconfig.sgml |   78 ----
 doc/reference/tmpl/oobs-session.sgml        |  115 -----
 doc/reference/tmpl/oobs-share-nfs.sgml      |   70 ---
 doc/reference/tmpl/oobs-share-smb.sgml      |  123 ------
 doc/reference/tmpl/oobs-share.sgml          |   48 --
 doc/reference/tmpl/oobs-shell.sgml          |   39 --
 doc/reference/tmpl/oobs-shellsconfig.sgml   |   39 --
 doc/reference/tmpl/oobs-smbconfig.sgml      |  134 ------
 doc/reference/tmpl/oobs-statichost.sgml     |   76 ----
 doc/reference/tmpl/oobs-timeconfig.sgml     |  135 ------
 doc/reference/tmpl/oobs-user.sgml           |  283 ------------
 doc/reference/tmpl/oobs-usersconfig.sgml    |  162 -------
 doc/reference/tmpl/oobs.sgml                |   19 -
 oobs/oobs-group.c                           |    7 +
 oobs/oobs-groupsconfig.c                    |    7 +
 oobs/oobs-hostsconfig.c                     |    7 +
 oobs/oobs-iface-ethernet.c                  |    8 +
 oobs/oobs-iface-irlan.c                     |    8 +
 oobs/oobs-iface-plip.c                      |    8 +
 oobs/oobs-iface-ppp.c                       |    8 +
 oobs/oobs-iface-wireless.c                  |    8 +
 oobs/oobs-iface.c                           |    8 +
 oobs/oobs-ifacesconfig.c                    |    8 +
 oobs/oobs-list.c                            |    7 +
 oobs/oobs-nfsconfig.c                       |    7 +
 oobs/oobs-ntpconfig.c                       |    7 +
 oobs/oobs-ntpserver.c                       |    7 +
 oobs/oobs-object.c                          |    7 +
 oobs/oobs-selfconfig.c                      |    6 +
 oobs/oobs-service.c                         |    7 +
 oobs/oobs-servicesconfig.c                  |    7 +
 oobs/oobs-session.c                         |    6 +
 oobs/oobs-share-nfs.c                       |    7 +
 oobs/oobs-share-smb.c                       |    7 +
 oobs/oobs-share.c                           |    7 +
 oobs/oobs-smbconfig.c                       |    7 +
 oobs/oobs-statichost.c                      |    7 +
 oobs/oobs-timeconfig.c                      |    7 +
 oobs/oobs-user.c                            |    7 +
 oobs/oobs-usersconfig.c                     |    7 +
 63 files changed, 222 insertions(+), 3904 deletions(-)
---
diff --git a/configure.in b/configure.in
index c177fad..bdbee0b 100644
--- a/configure.in
+++ b/configure.in
@@ -39,7 +39,7 @@ AC_SUBST(GETTEXT_PACKAGE)
 AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE",[The name of the gettext domain])
 
 dnl Check for gtk-doc
-GTK_DOC_CHECK([1.0])
+GTK_DOC_CHECK([1.9])
 
 dnl =====================================================
 dnl required packages detection
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index bfb9b75..91855b5 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -9,7 +9,7 @@ DOC_MODULE=liboobs
 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 
 # Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=--deprecated-guards="OOBS_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--deprecated-guards="OOBS_DISABLE_DEPRECATED" --rebuild-sections --rebuild-types
 
 # The directory containing the source code. Relative to $(srcdir).
 # gtk-doc will search all .c & .h files beneath here for inline comments
@@ -46,7 +46,30 @@ content_files =	version.xml
 # Extra options to supply to gtkdoc-fixref.
 FIXXREF_OPTIONS=
 
+if ENABLE_GTK_DOC
 include $(top_srcdir)/gtk-doc.make
+else
+CLEANFILES =
+EXTRA_DIST =
+endif
 
 # Other files to distribute.
 EXTRA_DIST += version.xml.in
+
+CLEANFILES +=   *~				\
+		liboobs-scan.*		        \
+		liboobs.args		        \
+		liboobs.hierarchy		\
+		liboobs.interfaces		\
+		liboobs.prerequisites	        \
+		liboobs.signals		        \
+		*.bak				\
+		liboobs-decl-list.txt	        \
+		liboobs-decl.txt		\
+		liboobs-overrides.txt	        \
+		liboobs-undeclared.txt	        \
+		liboobs-undocumented.txt	\
+		*.stamp				\
+		version.xml			\
+		-rf html xml			\
+		$(NULL)
diff --git a/doc/reference/liboobs-docs.sgml b/doc/reference/liboobs-docs.sgml
index bc964c5..da5d26c 100644
--- a/doc/reference/liboobs-docs.sgml
+++ b/doc/reference/liboobs-docs.sgml
@@ -6,7 +6,7 @@
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
     <title>Liboobs (System configuration management) Reference Manual</title>
-    <releaseinfo>for liboobs &version;</releaseinfo>
+    <releaseinfo>This documentation describes liboobs &version;.</releaseinfo>
   </bookinfo>
 
   <chapter>
@@ -24,6 +24,7 @@
     <title>Users and groups management</title>
     <xi:include href="xml/oobs-groupsconfig.xml"/>
     <xi:include href="xml/oobs-usersconfig.xml"/>
+    <xi:include href="xml/oobs-selfconfig.xml"/>
     <xi:include href="xml/oobs-group.xml"/>
     <xi:include href="xml/oobs-user.xml"/>
   </chapter>
@@ -56,9 +57,8 @@
     <xi:include href="xml/oobs-iface.xml"/>
     <xi:include href="xml/oobs-iface-ethernet.xml"/>
     <xi:include href="xml/oobs-iface-irlan.xml"/>
-    <xi:include href="xml/oobs-iface-isdn.xml"/>
-    <xi:include href="xml/oobs-iface-modem.xml"/>
     <xi:include href="xml/oobs-iface-plip.xml"/>
+    <xi:include href="xml/oobs-iface-ppp.xml"/>
     <xi:include href="xml/oobs-iface-wireless.xml"/>
   </chapter>
 
diff --git a/oobs/oobs-group.c b/oobs/oobs-group.c
index 5f32a02..cc93b37 100644
--- a/oobs/oobs-group.c
+++ b/oobs/oobs-group.c
@@ -29,6 +29,13 @@
 #include "utils.h"
 #include <crypt.h>
 
+/**
+ * SECTION:oobs-group
+ * @title: OobsGroup
+ * @short_description: Object that represents an individual group
+ * @see_also: #OobsGroupsConfig
+ **/
+
 #define OOBS_GROUP_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_GROUP, OobsGroupPrivate))
 
 typedef struct _OobsGroupPrivate OobsGroupPrivate;
diff --git a/oobs/oobs-groupsconfig.c b/oobs/oobs-groupsconfig.c
index 74a8d51..8debeca 100644
--- a/oobs/oobs-groupsconfig.c
+++ b/oobs/oobs-groupsconfig.c
@@ -32,6 +32,13 @@
 #include "oobs-defines.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-groupsconfig
+ * @title: OobsGroupsConfig
+ * @short_description: Object that represents groups configuration
+ * @see_also: #OobsGroup
+ **/
+
 #define GROUPS_CONFIG_REMOTE_OBJECT "GroupsConfig"
 #define OOBS_GROUPS_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_GROUPS_CONFIG, OobsGroupsConfigPrivate))
 
diff --git a/oobs/oobs-hostsconfig.c b/oobs/oobs-hostsconfig.c
index fadcba6..4b4ebd4 100644
--- a/oobs/oobs-hostsconfig.c
+++ b/oobs/oobs-hostsconfig.c
@@ -28,6 +28,13 @@
 #include "oobs-statichost.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-hostsconfig
+ * @title: OobsHostsConfig
+ * @short_description: Object that represents hosts resolution configuration
+ * @see_also: #OobsStaticHost
+ **/
+
 #define HOSTS_CONFIG_REMOTE_OBJECT "HostsConfig"
 #define OOBS_HOSTS_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_HOSTS_CONFIG, OobsHostsConfigPrivate))
 
diff --git a/oobs/oobs-iface-ethernet.c b/oobs/oobs-iface-ethernet.c
index 125f3c1..d5c9d91 100644
--- a/oobs/oobs-iface-ethernet.c
+++ b/oobs/oobs-iface-ethernet.c
@@ -24,6 +24,14 @@
 #include "oobs-iface-ethernet.h"
 #include "oobs-iface.h"
 
+/**
+ * SECTION:oobs-iface-ethernet
+ * @title: OobsIfaceEthernet
+ * @short_description: Object that represents an individual Ethernet interface
+ * @see_also: #OobsIface, #OobsIfacesConfig, #OobsIfaceIRLan,
+ *     #OobsIfacePlip, #OobsIfacePPP, #OobsIfaceWireless
+ **/
+
 #define OOBS_IFACE_ETHERNET_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_IFACE_ETHERNET, OobsIfaceEthernetPrivate))
 
 typedef struct _OobsIfaceEthernetPrivate OobsIfaceEthernetPrivate;
diff --git a/oobs/oobs-iface-irlan.c b/oobs/oobs-iface-irlan.c
index 239ceb0..8646ba4 100644
--- a/oobs/oobs-iface-irlan.c
+++ b/oobs/oobs-iface-irlan.c
@@ -22,6 +22,14 @@
 #include "oobs-iface-irlan.h"
 #include "oobs-iface-ethernet.h"
 
+/**
+ * SECTION:oobs-iface-irlan
+ * @title: OobsIfaceIRLan
+ * @short_description: Object that represents an individual IRLan interface
+ * @see_also: #OobsIface, #OobsIfacesConfig, #OobsIfaceEthernet,
+ *     #OobsIfacePlip, #OobsIfacePPP, #OobsIfaceWireless
+ **/
+
 static void oobs_iface_irlan_class_init (OobsIfaceIRLanClass *class);
 static void oobs_iface_irlan_init (OobsIfaceIRLan *iface);
 
diff --git a/oobs/oobs-iface-plip.c b/oobs/oobs-iface-plip.c
index d96146f..bd59d0c 100644
--- a/oobs/oobs-iface-plip.c
+++ b/oobs/oobs-iface-plip.c
@@ -22,6 +22,14 @@
 #include "oobs-iface-plip.h"
 #include "oobs-iface.h"
 
+/**
+ * SECTION:oobs-iface-plip
+ * @title: OobsIfacePlip
+ * @short_description: Object that represents an individual Plip interface
+ * @see_also: #OobsIface, #OobsIfacesConfig, #OobsIfaceEthernet,
+ *     #OobsIfaceIRLan, #OobsIfacePPP, #OobsIfaceWireless
+ **/
+
 #define OOBS_IFACE_PLIP_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_IFACE_PLIP, OobsIfacePlipPrivate))
 
 typedef struct _OobsIfacePlipPrivate OobsIfacePlipPrivate;
diff --git a/oobs/oobs-iface-ppp.c b/oobs/oobs-iface-ppp.c
index 29a0265..cea861f 100644
--- a/oobs/oobs-iface-ppp.c
+++ b/oobs/oobs-iface-ppp.c
@@ -24,6 +24,14 @@
 
 #include <string.h>
 
+/**
+ * SECTION:oobs-iface-ppp
+ * @title: OobsIfacePPP
+ * @short_description: Object that represents an individual PPP interface
+ * @see_also: #OobsIface, #OobsIfacesConfig, #OobsIfaceEthernet,
+ *     #OobsIfaceIRLan, #OobsIfacePlip, #OobsIfaceWireless
+ **/
+
 #define OOBS_IFACE_PPP_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_IFACE_PPP, OobsIfacePPPPrivate))
 
 typedef struct _OobsIfacePPPPrivate OobsIfacePPPPrivate;
diff --git a/oobs/oobs-iface-wireless.c b/oobs/oobs-iface-wireless.c
index c8556e5..53d8ed4 100644
--- a/oobs/oobs-iface-wireless.c
+++ b/oobs/oobs-iface-wireless.c
@@ -22,6 +22,14 @@
 #include "oobs-iface-wireless.h"
 #include "oobs-iface.h"
 
+/**
+ * SECTION:oobs-iface-wireless
+ * @title: OobsIfaceWireless
+ * @short_description: Object that represents an individual Wireless interface
+ * @see_also: #OobsIface, #OobsIfacesConfig, #OobsIfaceEthernet,
+ *     #OobsIfaceIRLan, #OobsIfacePlip, #OobsIfacePPP, #OobsIfaceWireless
+ **/
+
 #define OOBS_IFACE_WIRELESS_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_IFACE_WIRELESS, OobsIfaceWirelessPrivate))
 
 typedef struct _OobsIfaceWirelessPrivate OobsIfaceWirelessPrivate;
diff --git a/oobs/oobs-iface.c b/oobs/oobs-iface.c
index f39cf97..0712626 100644
--- a/oobs/oobs-iface.c
+++ b/oobs/oobs-iface.c
@@ -21,6 +21,14 @@
 #include <glib-object.h>
 #include "oobs-iface.h"
 
+/**
+ * SECTION:oobs-iface
+ * @title: OobsIface
+ * @short_description: Base object for network interfaces
+ * @see_also: #OobsIfacesConfig, #OobsIfaceEthernet, #OobsIfaceIRLan,
+ *     #OobsIfacePlip, #OobsIfacePPP, #OobsIfaceWireless
+ **/
+
 #define OOBS_IFACE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_IFACE, OobsIfacePrivate))
 
 typedef struct _OobsIfacePrivate OobsIfacePrivate;
diff --git a/oobs/oobs-ifacesconfig.c b/oobs/oobs-ifacesconfig.c
index 8268128..53f24cd 100644
--- a/oobs/oobs-ifacesconfig.c
+++ b/oobs/oobs-ifacesconfig.c
@@ -35,6 +35,14 @@
 #include "utils.h"
 #include "config.h"
 
+/**
+ * SECTION:oobs-ifacesconfig
+ * @title: OobsIfacesConfig
+ * @short_description: Object that represents network interfaces configuration
+ * @see_also: #OobsIface, #OobsIfaceEthernet, #OobsIfaceIRLan,
+ *     #OobsIfacePlip, #OobsIfacePPP, #OobsIfaceWireless
+ **/
+
 #define IFACES_CONFIG_REMOTE_OBJECT "IfacesConfig"
 #define OOBS_IFACES_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_IFACES_CONFIG, OobsIfacesConfigPrivate))
 
diff --git a/oobs/oobs-list.c b/oobs/oobs-list.c
index f02e1e7..5b25b00 100644
--- a/oobs/oobs-list.c
+++ b/oobs/oobs-list.c
@@ -24,6 +24,13 @@
 #include "oobs-object.h"
 #include "oobs-list.h"
 
+/**
+ * SECTION:oobs-list
+ * @title: OobsList
+ * @short_description: Object to deal with several configuration elements
+ * @see_also: #OobsObject
+ **/
+
 #define OOBS_LIST_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_LIST, OobsListPrivate))
 
 typedef struct _OobsListPrivate OobsListPrivate;
diff --git a/oobs/oobs-nfsconfig.c b/oobs/oobs-nfsconfig.c
index 017d07e..b365b7a 100644
--- a/oobs/oobs-nfsconfig.c
+++ b/oobs/oobs-nfsconfig.c
@@ -31,6 +31,13 @@
 #include "oobs-share-nfs.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-nfsconfig
+ * @title: OobsNFSConfig
+ * @short_description: Object that represents NFS configuration
+ * @see_also: #OobsShareNFS, #OobsSMBConfig
+ **/
+
 #define NFS_CONFIG_REMOTE_OBJECT "NFSConfig"
 #define OOBS_NFS_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_NFS_CONFIG, OobsNFSConfigPrivate))
 
diff --git a/oobs/oobs-ntpconfig.c b/oobs/oobs-ntpconfig.c
index 7cd039f..904c146 100644
--- a/oobs/oobs-ntpconfig.c
+++ b/oobs/oobs-ntpconfig.c
@@ -28,6 +28,13 @@
 #include "oobs-ntpserver.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-ntpconfig
+ * @title: OobsNTPConfig
+ * @short_description: Object that represents NTP configuration
+ * @see_also: #OobsNTPServer, #OobsTimeConfig
+ **/
+
 #define NTP_CONFIG_REMOTE_OBJECT "NTPConfig"
 #define OOBS_NTP_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_NTP_CONFIG, OobsNTPConfigPrivate))
 
diff --git a/oobs/oobs-ntpserver.c b/oobs/oobs-ntpserver.c
index 2b4d2f4..377d059 100644
--- a/oobs/oobs-ntpserver.c
+++ b/oobs/oobs-ntpserver.c
@@ -21,6 +21,13 @@
 #include <glib-object.h>
 #include "oobs-ntpserver.h"
 
+/**
+ * SECTION:oobs-ntpserver
+ * @title: OobsNTPServer
+ * @short_description: Object that represents an individual NTP server
+ * @see_also: #OobsNTPConfig
+ **/
+
 #define OOBS_NTP_SERVER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_NTP_SERVER, OobsNTPServerPrivate))
 
 typedef struct _OobsNTPServerPrivate OobsNTPServerPrivate;
diff --git a/oobs/oobs-object.c b/oobs/oobs-object.c
index 0f06080..3245c3f 100644
--- a/oobs/oobs-object.c
+++ b/oobs/oobs-object.c
@@ -25,6 +25,13 @@
 #include "oobs-session.h"
 #include "oobs-session-private.h"
 
+/**
+ * SECTION:oobs-object
+ * @title: OobsObject
+ * @short_description: Base object for all configuration objects
+ * @see_also: #OobsList
+ **/
+
 #define OOBS_OBJECT_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_OBJECT, OobsObjectPrivate))
 #define POLKIT_ACTION "org.freedesktop.systemtoolsbackends.set"
 
diff --git a/oobs/oobs-selfconfig.c b/oobs/oobs-selfconfig.c
index 2b05cdd..3c74bb8 100644
--- a/oobs/oobs-selfconfig.c
+++ b/oobs/oobs-selfconfig.c
@@ -29,6 +29,12 @@
 #include "oobs-user.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-selfconfig
+ * @title: OobsSelfConfig
+ * @short_description: Object that represents the current user
+ **/
+
 #define SELF_CONFIG_REMOTE_OBJECT "SelfConfig"
 #define OOBS_SELF_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SELF_CONFIG, OobsSelfConfigPrivate))
 #define POLICY_KIT_SELF_ACTION "org.freedesktop.systemtoolsbackends.self.set"
diff --git a/oobs/oobs-service.c b/oobs/oobs-service.c
index 7d3acae..238b785 100644
--- a/oobs/oobs-service.c
+++ b/oobs/oobs-service.c
@@ -21,6 +21,13 @@
 #include <glib-object.h>
 #include "oobs-service.h"
 
+/**
+ * SECTION:oobs-service
+ * @title: OobsService
+ * @short_description: Object that represents an individual init.d service
+ * @see_also: #OobsServicesConfig
+ **/
+
 #define OOBS_SERVICE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SERVICE, OobsServicePrivate))
 
 typedef struct _OobsServicePrivate  OobsServicePrivate;
diff --git a/oobs/oobs-servicesconfig.c b/oobs/oobs-servicesconfig.c
index b2dc982..790fa90 100644
--- a/oobs/oobs-servicesconfig.c
+++ b/oobs/oobs-servicesconfig.c
@@ -30,6 +30,13 @@
 #include "oobs-service.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-servicesconfig
+ * @title: OobsServicesConfig
+ * @short_description: Object that represents the configuration of services that start/stop during init/shutdown
+ * @see_also: #OobsService
+ **/
+
 #define SERVICES_CONFIG_REMOTE_OBJECT "ServicesConfig"
 #define OOBS_SERVICES_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SERVICES_CONFIG, OobsServicesConfigPrivate))
 
diff --git a/oobs/oobs-session.c b/oobs/oobs-session.c
index d20f121..dd9d66a 100644
--- a/oobs/oobs-session.c
+++ b/oobs/oobs-session.c
@@ -28,6 +28,12 @@
 #include "oobs-object.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-session
+ * @title: OobsSession
+ * @short_description: Manager of the connection to the backends
+ **/
+
 #define OOBS_SESSION_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SESSION, OobsSessionPrivate))
 #define PLATFORMS_PATH OOBS_DBUS_PATH_PREFIX "/Platform"
 #define PLATFORMS_INTERFACE OOBS_DBUS_METHOD_PREFIX ".Platform"
diff --git a/oobs/oobs-share-nfs.c b/oobs/oobs-share-nfs.c
index 76bf2dd..5fbf5ed 100644
--- a/oobs/oobs-share-nfs.c
+++ b/oobs/oobs-share-nfs.c
@@ -22,6 +22,13 @@
 #include "oobs-share.h"
 #include "oobs-share-nfs.h"
 
+/**
+ * SECTION:oobs-share-nfs
+ * @title: OobsShareNFS
+ * @short_description: Object that represents NFS configuration
+ * @see_also: #OobsShare, #OobsNFSConfig
+ **/
+
 #define OOBS_SHARE_NFS_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SHARE_NFS, OobsShareNFSPrivate))
 
 typedef struct _OobsShareNFSPrivate OobsShareNFSPrivate;
diff --git a/oobs/oobs-share-smb.c b/oobs/oobs-share-smb.c
index 08773bc..c479daf 100644
--- a/oobs/oobs-share-smb.c
+++ b/oobs/oobs-share-smb.c
@@ -22,6 +22,13 @@
 #include "oobs-share.h"
 #include "oobs-share-smb.h"
 
+/**
+ * SECTION:oobs-share-smb
+ * @title: OobsShareSMB
+ * @short_description: Object that represents SMB configuration.
+ * @see_also: #OobsShare, #OobsSMBConfig
+ **/
+
 #define OOBS_SHARE_SMB_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SHARE_SMB, OobsShareSMBPrivate))
 
 typedef struct _OobsShareSMBPrivate OobsShareSMBPrivate;
diff --git a/oobs/oobs-share.c b/oobs/oobs-share.c
index def9ede..2b9e3e3 100644
--- a/oobs/oobs-share.c
+++ b/oobs/oobs-share.c
@@ -21,6 +21,13 @@
 #include <glib-object.h>
 #include "oobs-share.h"
 
+/**
+ * SECTION:oobs-share
+ * @title: OobsShare
+ * @short_description: Base object for shared folders
+ * @see_also: #OobsShareNFS, #OobsShareSMB
+ **/
+
 #define OOBS_SHARE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SHARE, OobsSharePrivate))
 
 typedef struct _OobsSharePrivate OobsSharePrivate;
diff --git a/oobs/oobs-smbconfig.c b/oobs/oobs-smbconfig.c
index 618e114..0941785 100644
--- a/oobs/oobs-smbconfig.c
+++ b/oobs/oobs-smbconfig.c
@@ -32,6 +32,13 @@
 #include "oobs-user.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-smbconfig
+ * @title: OobsSMBConfig
+ * @short_description: Object that represents SMB configuration
+ * @see_also: #OobsShareSMB, #OobsNFSConfig
+ **/
+
 #define SMB_CONFIG_REMOTE_OBJECT "SMBConfig"
 #define OOBS_SMB_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_SMB_CONFIG, OobsSMBConfigPrivate))
 
diff --git a/oobs/oobs-statichost.c b/oobs/oobs-statichost.c
index c33ed32..781dfc0 100644
--- a/oobs/oobs-statichost.c
+++ b/oobs/oobs-statichost.c
@@ -21,6 +21,13 @@
 #include <glib-object.h>
 #include "oobs-statichost.h"
 
+/**
+ * SECTION:oobs-statichost
+ * @title: OobsStaticHost
+ * @short_description: Object that represents an individual static host settings
+ * @see_also: #OobsHostsConfig
+ **/
+
 #define OOBS_STATIC_HOST_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_STATIC_HOST, OobsStaticHostPrivate))
 
 typedef struct _OobsStaticHostPrivate OobsStaticHostPrivate;
diff --git a/oobs/oobs-timeconfig.c b/oobs/oobs-timeconfig.c
index a1f9390..b6a8bd0 100644
--- a/oobs/oobs-timeconfig.c
+++ b/oobs/oobs-timeconfig.c
@@ -29,6 +29,13 @@
 #include "oobs-timeconfig.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-timeconfig
+ * @title: OobsTimeConfig
+ * @short_description: Object that represents time configuration
+ * @see_also: #OobsNTPConfig, #OobsNTPServer
+ **/
+
 #define TIME_CONFIG_REMOTE_OBJECT "TimeConfig"
 #define OOBS_TIME_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_TIME_CONFIG, OobsTimeConfigPrivate))
 
diff --git a/oobs/oobs-user.c b/oobs/oobs-user.c
index 7bf0725..09cc670 100644
--- a/oobs/oobs-user.c
+++ b/oobs/oobs-user.c
@@ -32,6 +32,13 @@
 #include "oobs-defines.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-user
+ * @title: OobsUser
+ * @short_description: Object that represents an individual user
+ * @see_also: #OobsUsersConfig
+ **/
+
 #define OOBS_USER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_USER, OobsUserPrivate))
 
 typedef struct _OobsUserPrivate OobsUserPrivate;
diff --git a/oobs/oobs-usersconfig.c b/oobs/oobs-usersconfig.c
index e11a801..09815db 100644
--- a/oobs/oobs-usersconfig.c
+++ b/oobs/oobs-usersconfig.c
@@ -33,6 +33,13 @@
 #include "oobs-group.h"
 #include "utils.h"
 
+/**
+ * SECTION:oobs-usersconfig
+ * @title: OobsUsersConfig
+ * @short_description: Object that represents users configuration
+ * @see_also: #OobsUser
+ **/
+
 #define USERS_CONFIG_REMOTE_OBJECT "UsersConfig"
 #define OOBS_USERS_CONFIG_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OOBS_TYPE_USERS_CONFIG, OobsUsersConfigPrivate))
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]