ayatana-commits team mailing list archive

[Aurélien Gâteau <aurelien.gateau@xxxxxxxxxxxxx>]

Aurélien Gâteau has proposed merging lp:~agateau/dbusmenu/xml-doc-fix into lp:dbusmenu.

Requested reviews:
  Ted Gould (ted)

For more details, see:
https://code.launchpad.net/~agateau/dbusmenu/xml-doc-fix/+merge/51508

Improves dbus-menu.xml doc a bit, see commit for details
-- 
https://code.launchpad.net/~agateau/dbusmenu/xml-doc-fix/+merge/51508
Your team ayatana-commits is subscribed to branch lp:dbusmenu.

=== modified file 'libdbusmenu-glib/dbus-menu.xml'
--- libdbusmenu-glib/dbus-menu.xml	2011-02-24 19:52:01 +0000
+++ libdbusmenu-glib/dbus-menu.xml	2011-02-28 10:14:15 +0000
@@ -195,21 +195,24 @@
 			<dox:d>
 			  Provides the layout and propertiers that are attached to the entries
 			  that are in the layout.  It only gives the items that are children
-			  of the item that is specified in @parentId.  It will return all of the
-			  properties or specific ones depending of the value in @propertyNames.
+			  of the item that is specified in @a parentId.  It will return all of the
+			  properties or specific ones depending of the value in @a propertyNames.
 
 			  The format is recursive, where the second 'v' is in the same format
-			  as the original 'a(ia(sv)a(v))'.  If the @recursive flag is set to
-			  less than one then the second array will have zero entries.
+			  as the original 'a(ia{sv}av)'.  Its content depends on the value
+			  of @a recursionDepth.
 			</dox:d>
 			<arg type="i" name="parentId" direction="in">
 				<dox:d>The ID of the parent node for the layout.  For
 				grabbing the layout from the root node use zero.</dox:d>
 			</arg>
-			<arg type="i" name="recurse" direction="in">
+			<arg type="i" name="recursionDepth" direction="in">
 				<dox:d>
-				  The amount of levels of recursion to use.  -1, as value would
-				  deliver all the items under the @parentId.
+				  The amount of levels of recursion to use.  This affects the
+				  content of the second variant array.
+				  - -1: deliver all the items under the @a parentId.
+				  - 0: no recursion, the array will be empty.
+				  - n: array will contains items up to 'n' level depth.
 				</dox:d>
 			</arg>
 			<arg type="as" name="propertyNames" direction="in" >
@@ -224,13 +227,11 @@
 				with layoutUpdated signals.</dox:d>
 			</arg>
 			<arg type="(ia{sv}av)" name="layout" direction="out">
-				<dox:d>The layout as an XML string of IDs.</dox:d>
+				<dox:d>The layout, as a recursive structure.</dox:d>
 			</arg>
 		</method>
 
 		<method name="GetGroupProperties">
-			<annotation name="com.trolltech.QtDBus.QtTypeName.In0" value="QVariantList"/>
-			<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="DBusMenuItemList"/>
 			<dox:d>
 			Returns the list of items which are children of @a parentId.
 			</dox:d>
@@ -327,7 +328,7 @@
 			properties.
 			</dox:d>
 			<arg type="a(ia{sv})" name="updatedProps" direction="out" />
-			<arg type="a(ias)"  name="removedProps" direction="out" />
+			<arg type="a(ias)" name="removedProps" direction="out" />
 		</signal>
 		<signal name="LayoutUpdated">
 			<dox:d>