From d758a842a491f7518b349767dc7fde8fcc64933b Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Mon, 11 May 2009 17:19:39 -0500 Subject: Object and section docs. --- libdbusmenu-glib/client.h | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) (limited to 'libdbusmenu-glib/client.h') diff --git a/libdbusmenu-glib/client.h b/libdbusmenu-glib/client.h index d4c5ee9..002e0e5 100644 --- a/libdbusmenu-glib/client.h +++ b/libdbusmenu-glib/client.h @@ -20,9 +20,20 @@ G_BEGIN_DECLS #define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name" #define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object" -typedef struct _DbusmenuClient DbusmenuClient; -typedef struct _DbusmenuClientClass DbusmenuClientClass; +/** + DbusmenuClientClass: + @parent_class: #GObjectClass + @layout_updated: Slot for #DbusmenuClient::layout-updated. + @reserved1: Reserved for future use. + @reserved2: Reserved for future use. + @reserved3: Reserved for future use. + @reserved4: Reserved for future use. + A simple class that takes all of the information from a + #DbusmenuServer over DBus and makes the same set of + #DbusmenuMenuitem objects appear on the other side. +*/ +typedef struct _DbusmenuClientClass DbusmenuClientClass; struct _DbusmenuClientClass { GObjectClass parent_class; @@ -35,6 +46,14 @@ struct _DbusmenuClientClass { void (*reserved4) (void); }; +/** + DbusmenuClient: + @parent: #GObject. + + The client for a #DbusmenuServer creating a shared + object set of #DbusmenuMenuitem objects. +*/ +typedef struct _DbusmenuClient DbusmenuClient; struct _DbusmenuClient { GObject parent; }; @@ -43,6 +62,27 @@ GType dbusmenu_client_get_type (void); DbusmenuClient * dbusmenu_client_new (const gchar * name, const gchar * object); DbusmenuMenuitem * dbusmenu_client_get_root (DbusmenuClient * client); +/** + SECTION:client + @short_description: The catcher of all the server traffic + @stability: Unstable + @include: libdbusmenu-glib/client.h + + The client exists as a mirror to the server. For most folks + all they will do with a client is set it up to connect to + a server and then watch as the menu items on their side + of the bus change. This is all they should need to know about + the client, that it magically makes their menuitems dance. + + It does this by setting up signal watchers and adjusting + the menuitems appropriately. Most users should watch the + menu items and the signal #DbusmenuClient::layout-changed for + larger events so that they can be optimized. It is possible + with that signal that even the root node would change. If + that doesn't happen the normal signals on the individual + nodes should be enough for most users. +*/ + G_END_DECLS #endif -- cgit v1.2.3