ayatana-commits team mailing list archive

[noreply@xxxxxxxxxxxxx]

Merge authors:
  Ted Gould (ted)
------------------------------------------------------------
revno: 105 [merge]
committer: Ted Gould <ted@xxxxxxxx>
branch nick: trunk
timestamp: Fri 2010-06-04 13:12:55 -0500
message:
  Changing some of our annotations so they build better on updated g-ir-scanner
modified:
  libdbusmenu-glib/menuitem.c
  libdbusmenu-glib/menuitem.h


--
lp:dbusmenu
https://code.launchpad.net/~dbusmenu-team/dbusmenu/trunk

Your team ayatana-commits is subscribed to branch lp:dbusmenu.
To unsubscribe from this branch go to https://code.launchpad.net/~dbusmenu-team/dbusmenu/trunk/+edit-subscription

=== modified file 'libdbusmenu-glib/menuitem.c'
--- libdbusmenu-glib/menuitem.c	2010-04-16 16:43:06 +0000
+++ libdbusmenu-glib/menuitem.c	2010-05-27 21:33:38 +0000
@@ -1199,7 +1199,7 @@
 /**
 	dbusmenu_menuitem_buildxml:
 	@mi: #DbusmenuMenuitem to represent in XML
-	@array: A list of string that will be turned into an XML file
+	@array: (element-type utf8): A list of string that will be turned into an XML file
 
 	This function will add strings to the array @array.  It will put
 	at least one entry if this menu item has no children.  If it has
@@ -1247,7 +1247,7 @@
 	dbusmenu_menuitem_foreach:
 	@mi: The #DbusmenItem to start from
 	@func: Function to call on every node in the tree
-	@data: User data to pass to the function
+	@data: (closure): User data to pass to the function
 
 	This calls the function @func on this menu item and all
 	of the children of this item.  And their children.  And
@@ -1305,7 +1305,7 @@
 	dbusmenu_menuitem_send_about_to_show:
 	@mi: The #DbusmenuMenuitem to send the signal on.
 	@cb: Callback to call when the call has returned.
-	@cb_data: Data to pass to the callback.
+	@cb_data: (closure): Data to pass to the callback.
 
 	This function is used to send the even that the submenu
 	of this item is about to be shown.  Callers to this event

=== modified file 'libdbusmenu-glib/menuitem.h'
--- libdbusmenu-glib/menuitem.h	2010-04-15 04:47:01 +0000
+++ libdbusmenu-glib/menuitem.h	2010-06-04 17:17:21 +0000
@@ -69,15 +69,15 @@
 #define DBUSMENU_MENUITEM_ICON_NAME_BLANK            "blank-icon"
 
 /**
-	DbusmenuMenuitem:
-
-	This is the #GObject based object that represents a menu
-	item.  It gets created the same on both the client and
-	the server side and libdbusmenu-glib does the work of making
-	this object model appear on both sides of DBus.  Simple
-	really, though through updates and people coming on and off
-	the bus it can lead to lots of fun complex scenarios.
-*/
+ * DbusmenuMenuitem:
+ * 
+ * This is the #GObject based object that represents a menu
+ * item.  It gets created the same on both the client and
+ * the server side and libdbusmenu-glib does the work of making
+ * this object model appear on both sides of DBus.  Simple
+ * really, though through updates and people coming on and off
+ * the bus it can lead to lots of fun complex scenarios.
+ */
 typedef struct _DbusmenuMenuitem      DbusmenuMenuitem;
 struct _DbusmenuMenuitem
 {
@@ -85,36 +85,41 @@
 };
 
 /**
-	dbusmenu_menuitem_about_to_show_cb:
-	@mi Menu item that should be shown
-	@user_data Extra user data sent with the function
-
-	Callback prototype for a callback that is called when the
-	menu should be shown.
-*/
+ * dbusmenu_menuitem_about_to_show_cb:
+ * @mi: Menu item that should be shown
+ * @user_data: (closure): Extra user data sent with the function
+ * 
+ * Callback prototype for a callback that is called when the
+ * menu should be shown.
+ */
 typedef void (*dbusmenu_menuitem_about_to_show_cb) (DbusmenuMenuitem * mi, gpointer user_data);
 
+/**
+ * dbusmenu_menuitem_buildxml_slot_t:
+ * @mi: (in): Menu item that should be built from
+ * @stringarray: (inout) (transfer none) (array) (element-type utf8): An array of strings that can be combined into an XML file.
+ * 
+ * This is the function that is called to represent this menu item
+ * as an XML fragment.  Should call it's own children.
+ */
+typedef void (*dbusmenu_menuitem_buildxml_slot_t) (DbusmenuMenuitem * mi, GPtrArray* stringarray);
 
 /**
-	DbusmenuMenuitemClass:
-	@property_changed: Slot for #DbusmenuMenuitem::property-changed.
-	@item_activated: Slot for #DbusmenuMenuitem::item-activated.
-	@child_added: Slot for #DbusmenuMenuitem::child-added.
-	@child_removed: Slot for #DbusmenuMenuitem::child-removed.
-	@child_moved: Slot for #DbusmenuMenuitem::child-moved.
-	@realized: Slot for #DbusmenuMenuitem::realized.
-	@buildxml: Virtual function that appends the strings required
-	           to represent this menu item in the menu XML file.
-	@handle_event: This function is to override how events are handled
-			by subclasses.  Look at #dbusmenu_menuitem_handle_event for
-			lots of good information.
-	@send_about_to_show: Virtual function that notifies server that the
-			client is about to show a menu.
-	@reserved1: Reserved for future use.
-	@reserved2: Reserved for future use.
-	@reserved3: Reserved for future use.
-	@reserved4: Reserved for future use.
-*/
+ * DbusmenuMenuitemClass:
+ * @property_changed: Slot for #DbusmenuMenuitem::property-changed.
+ * @item_activated: Slot for #DbusmenuMenuitem::item-activated.
+ * @child_added: Slot for #DbusmenuMenuitem::child-added.
+ * @child_removed: Slot for #DbusmenuMenuitem::child-removed.
+ * @child_moved: Slot for #DbusmenuMenuitem::child-moved.
+ * @realized: Slot for #DbusmenuMenuitem::realized.
+ * @buildxml: Virtual function that appends the strings required to represent this menu item in the menu XML file.
+ * @handle_event: This function is to override how events are handled by subclasses.  Look at #dbusmenu_menuitem_handle_event for lots of good information.
+ * @send_about_to_show: Virtual function that notifies server that the client is about to show a menu.
+ * @reserved1: Reserved for future use.
+ * @reserved2: Reserved for future use.
+ * @reserved3: Reserved for future use.
+ * @reserved4: Reserved for future use.
+ */
 typedef struct _DbusmenuMenuitemClass DbusmenuMenuitemClass;
 struct _DbusmenuMenuitemClass
 {
@@ -129,7 +134,7 @@
 	void (*realized) (void);
 
 	/* Virtual functions */
-	void (*buildxml) (GPtrArray * stringarray);
+	dbusmenu_menuitem_buildxml_slot_t buildxml;
 	void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, const GValue * value, guint timestamp);
 	void (*send_about_to_show) (DbusmenuMenuitem * mi, dbusmenu_menuitem_about_to_show_cb cb, gpointer cb_data);
 
@@ -179,23 +184,23 @@
 void dbusmenu_menuitem_send_about_to_show (DbusmenuMenuitem * mi, dbusmenu_menuitem_about_to_show_cb cb, gpointer cb_data);
 
 /**
-	SECTION:menuitem
-	@short_description: A lowlevel represenation of a menuitem
-	@stability: Unstable
-	@include: libdbusmenu-glib/menuitem.h
-
-	A #DbusmenuMenuitem is the lowest level of represenation of a
-	single item in a menu.  It gets created on the server side
-	and copied over to the client side where it gets rendered.  As
-	the server starts to change it, and grow it, and do all kinds
-	of fun stuff that information is transfered over DBus and the
-	client updates it's understanding of the object model.
-
-	Most people using either the client or the server should be
-	able to deal mostly with #DbusmenuMenuitem objects.  These
-	are simple, but then they can be attached to more complex
-	objects and handled appropriately.
-*/
+ * SECTION:menuitem
+ * @short_description: A lowlevel represenation of a menuitem
+ * @stability: Unstable
+ * @include: libdbusmenu-glib/menuitem.h
+ * 
+ * A #DbusmenuMenuitem is the lowest level of represenation of a
+ * single item in a menu.  It gets created on the server side
+ * and copied over to the client side where it gets rendered.  As
+ * the server starts to change it, and grow it, and do all kinds
+ * of fun stuff that information is transfered over DBus and the
+ * client updates it's understanding of the object model.
+ * 
+ * Most people using either the client or the server should be
+ * able to deal mostly with #DbusmenuMenuitem objects.  These
+ * are simple, but then they can be attached to more complex
+ * objects and handled appropriately.
+ */
 
 G_END_DECLS