aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2010-10-27 14:32:33 -0400
committerTed Gould <ted@gould.cx>2010-10-27 14:32:33 -0400
commite879b3574445305c4d672869dd8307f570f6bd6c (patch)
tree5093ef786be92352afbcade8c18465c04925fe47
parent38882b4705957a5f0d1f80a92aa8c6e7c24fd380 (diff)
downloadlibdbusmenu-e879b3574445305c4d672869dd8307f570f6bd6c.tar.gz
libdbusmenu-e879b3574445305c4d672869dd8307f570f6bd6c.tar.bz2
libdbusmenu-e879b3574445305c4d672869dd8307f570f6bd6c.zip
Changing the comment to describe the new parameters
-rw-r--r--libdbusmenu-glib/dbus-menu.xml28
1 files changed, 9 insertions, 19 deletions
diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml
index 2c195fa..17f3348 100644
--- a/libdbusmenu-glib/dbus-menu.xml
+++ b/libdbusmenu-glib/dbus-menu.xml
@@ -174,25 +174,15 @@ License version 3 and version 2.1 along with this program. If not, see
<!-- Functions -->
<method name="GetLayout">
- <dox:d><![CDATA[
- Provides an XML representation of the menu hierarchy
-
- XML syntax:
-
- @verbatim
-<menu id="0"> # Root container
- <menu id="1"> # First level menu, for example "File"
- <menu id="2"/> ~ Second level menu, for example "Open"
- <menu id="3"/>
- ...
- </menu>
- <menu id="4"> # Another first level menu, say "Edit"
- ...
- </menu>
- ...
-</menu>
- @endverbatim
- ]]></dox:d>
+ <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.
+
+ The format is recursive, where the second 'v' is in the same format
+ as the original 'a(ia(sv)a(v))'.
+ </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>