Fixup documentation and move the private functions to a private header file

5 files changed, 109 insertions, 9 deletions

diff --git a/libdbusmenu-glib/Makefile.am b/libdbusmenu-glib/Makefile.am
index 92de502..8c177f7 100644
--- a/libdbusmenu-glib/Makefile.am
+++ b/libdbusmenu-glib/Makefile.am
@@ -39,6 +39,7 @@ libdbusmenu_glib_la_SOURCES = \
 	client-marshal.c \
 	client-menuitem.h \
 	client-menuitem.c \
+	client-private.h \
 	client.h \
 	client.c
 
diff --git a/libdbusmenu-glib/client-menuitem.c b/libdbusmenu-glib/client-menuitem.c
index b9e799f..60f8637 100644
--- a/libdbusmenu-glib/client-menuitem.c
+++ b/libdbusmenu-glib/client-menuitem.c
@@ -30,6 +30,7 @@ License version 3 and version 2.1 along with this program.  If not, see
 #endif
 
 #include "client-menuitem.h"
+#include "client-private.h"
 
 typedef struct _DbusmenuClientMenuitemPrivate DbusmenuClientMenuitemPrivate;
 
diff --git a/libdbusmenu-glib/client-private.h b/libdbusmenu-glib/client-private.h
new file mode 100644
index 0000000..f6df372
--- /dev/null
+++ b/libdbusmenu-glib/client-private.h
@@ -0,0 +1,48 @@
+/*
+A library to communicate a menu object set accross DBus and
+track updates and maintain consistency.
+
+Copyright 2011 Canonical Ltd.
+
+Authors:
+    Ted Gould <ted@canonical.com>
+
+This program is free software: you can redistribute it and/or modify it 
+under the terms of either or both of the following licenses:
+
+1) the GNU Lesser General Public License version 3, as published by the 
+Free Software Foundation; and/or
+2) the GNU Lesser General Public License version 2.1, as published by 
+the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful, but 
+WITHOUT ANY WARRANTY; without even the implied warranties of 
+MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR 
+PURPOSE.  See the applicable version of the GNU Lesser General Public 
+License for more details.
+
+You should have received a copy of both the GNU Lesser General Public 
+License version 3 and version 2.1 along with this program.  If not, see 
+<http://www.gnu.org/licenses/>
+*/
+
+#ifndef __DBUSMENU_CLIENT_PRIVATE_H__
+#define __DBUSMENU_CLIENT_PRIVATE_H__
+
+#include "client.h"
+
+G_BEGIN_DECLS
+
+void                 dbusmenu_client_send_event        (DbusmenuClient * client,
+                                                        gint id,
+                                                        const gchar * name,
+                                                        GVariant * variant,
+                                                        guint timestamp);
+void                 dbusmenu_client_send_about_to_show(DbusmenuClient * client,
+                                                        gint id,
+                                                        void (*cb) (gpointer user_data),
+                                                        gpointer cb_data);
+
+G_END_DECLS
+
+#endif
diff --git a/libdbusmenu-glib/client.c b/libdbusmenu-glib/client.c
index 0848294..ee1186b 100644
--- a/libdbusmenu-glib/client.c
+++ b/libdbusmenu-glib/client.c
@@ -33,6 +33,7 @@ License version 3 and version 2.1 along with this program.  If not, see
 #include <gio/gio.h>
 
 #include "client.h"
+#include "client-private.h"
 #include "menuitem.h"
 #include "menuitem-private.h"
 #include "client-menuitem.h"
diff --git a/libdbusmenu-glib/client.h b/libdbusmenu-glib/client.h
index a8e0899..7bb0e6a 100644
--- a/libdbusmenu-glib/client.h
+++ b/libdbusmenu-glib/client.h
@@ -43,17 +43,71 @@ G_BEGIN_DECLS
 #define DBUSMENU_IS_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), DBUSMENU_TYPE_CLIENT))
 #define DBUSMENU_CLIENT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), DBUSMENU_TYPE_CLIENT, DbusmenuClientClass))
 
+/**
+ * DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED:
+ *
+ * String to attach to signal #DbusmenuClient::layout-updated
+ */
 #define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED  "layout-updated"
+/**
+ * DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED:
+ *
+ * String to attach to signal #DbusmenuClient::root-changed
+ */
 #define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED    "root-changed"
+/**
+ * DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM:
+ *
+ * String to attach to signal #DbusmenuClient::new-menuitem
+ */
 #define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM    "new-menuitem"
+/**
+ * DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE:
+ *
+ * String to attach to signal #DbusmenuClient::item-activate
+ */
 #define DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE   "item-activate"
+/**
+ * DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT:
+ *
+ * String to attach to signal #DbusmenuClient::event-result
+ */
 #define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT    "event-result"
 
+/**
+ * DBUSMENU_CLIENT_PROP_DBUS_NAME:
+ *
+ * String to access property #DbusmenuClient:dbus-name
+ */
 #define DBUSMENU_CLIENT_PROP_DBUS_NAME     "dbus-name"
+/**
+ * DBUSMENU_CLIENT_PROP_DBUS_OBJECT:
+ *
+ * String to access property #DbusmenuClient:dbus-object
+ */
 #define DBUSMENU_CLIENT_PROP_DBUS_OBJECT   "dbus-object"
 
+/**
+ * DBUSMENU_CLIENT_TYPES_DEFAULT:
+ *
+ * Used to set the 'type' property on a menu item to create
+ * a standard menu item.
+ */
 #define DBUSMENU_CLIENT_TYPES_DEFAULT      "standard"
+/**
+ * DBUSMENU_CLIENT_TYPES_SEPARATOR:
+ *
+ * Used to set the 'type' property on a menu item to create
+ * a separator menu item.
+ */
 #define DBUSMENU_CLIENT_TYPES_SEPARATOR    "separator"
+/**
+ * DBUSMENU_CLIENT_TYPES_IMAGE:
+ *
+ * Used to set the 'type' property on a menu item to create
+ * an image menu item.  Deprecated as standard menu items now
+ * support images as well.
+ */
 #define DBUSMENU_CLIENT_TYPES_IMAGE        "standard"
 
 typedef struct _DbusmenuClientPrivate DbusmenuClientPrivate;
@@ -62,6 +116,7 @@ typedef struct _DbusmenuClientPrivate DbusmenuClientPrivate;
 	DbusmenuClientClass:
 	@parent_class: #GObjectClass
 	@layout_updated: Slot for #DbusmenuClient::layout-updated.
+	@root_changed: Slot for #DbusmenuClient::root-changed.
 	@new_menuitem: Slot for #DbusmenuClient::new-menuitem.
 	@item_activate: Slot for #DbusmenuClient::item-activate.
 	@event_result: Slot for #DbusmenuClient::event-error.
@@ -118,6 +173,9 @@ struct _DbusmenuClient {
 
 	The type handler is called when a dbusmenu item is created
 	with a matching type as setup in #dbusmenu_client_add_type_handler
+
+	Return value: #TRUE if the type has been handled.  #FALSE if this
+		function was somehow unable to handle it.
 */
 typedef gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem * newitem, DbusmenuMenuitem * parent, DbusmenuClient * client, gpointer user_data);
 
@@ -145,15 +203,6 @@ gboolean             dbusmenu_client_add_type_handler_full (DbusmenuClient * cli
                                                         DbusmenuClientTypeHandler newfunc,
                                                         gpointer user_data,
                                                         DbusmenuClientTypeDestroyHandler destroy_func);
-void                 dbusmenu_client_send_event        (DbusmenuClient * client,
-                                                        gint id,
-                                                        const gchar * name,
-                                                        GVariant * variant,
-                                                        guint timestamp);
-void                 dbusmenu_client_send_about_to_show(DbusmenuClient * client,
-                                                        gint id,
-                                                        void (*cb) (gpointer user_data),
-                                                        gpointer cb_data);
 
 /**
 	SECTION:client