diff options
| author | Aurelien Gateau <aurelien.gateau@canonical.com> | 2011-02-28 10:57:36 +0100 |
|---|---|---|
| committer | Aurelien Gateau <aurelien.gateau@canonical.com> | 2011-02-28 10:57:36 +0100 |
| commit | 356ee2d0385f8fd22ec60d84620c0eb2df018384 (patch) | |
| tree | 2873949fcb44b661e6762e90c054a452ed40bb5e | |
| parent | fbb337084d705302b965278525f0bb7bc2580d35 (diff) | |
| download | libdbusmenu-356ee2d0385f8fd22ec60d84620c0eb2df018384.tar.gz libdbusmenu-356ee2d0385f8fd22ec60d84620c0eb2df018384.tar.bz2 libdbusmenu-356ee2d0385f8fd22ec60d84620c0eb2df018384.zip | |
Doc fixes:
- Use "@a foo" for arguments, not "@foo"
- Rename "recurse" (which sounds boolean) to "recursionDepth"
- Removed dbusmenu-qt specific annotations
| -rw-r--r-- | libdbusmenu-glib/dbus-menu.xml | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index c0831e5..ffeca1e 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -177,21 +177,24 @@ License version 3 and version 2.1 along with this program. If not, see <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" > @@ -206,13 +209,11 @@ License version 3 and version 2.1 along with this program. If not, see 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> @@ -309,7 +310,7 @@ License version 3 and version 2.1 along with this program. If not, see 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> |