aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-glib/dbus-menu.xml
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2010-03-31 12:29:20 -0500
committerTed Gould <ted@gould.cx>2010-03-31 12:29:20 -0500
commit75b0bba462e192a32e4484e52d0751852d03df12 (patch)
tree14a773d3acc571310bd4ff9addd8d48c9e217c1f /libdbusmenu-glib/dbus-menu.xml
parentf3681a09522d6381eef14525eafdc4c467420879 (diff)
downloadlibdbusmenu-75b0bba462e192a32e4484e52d0751852d03df12.tar.gz
libdbusmenu-75b0bba462e192a32e4484e52d0751852d03df12.tar.bz2
libdbusmenu-75b0bba462e192a32e4484e52d0751852d03df12.zip
Adding a bunch of comments
Diffstat (limited to 'libdbusmenu-glib/dbus-menu.xml')
-rw-r--r--libdbusmenu-glib/dbus-menu.xml16
1 files changed, 14 insertions, 2 deletions
diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml
index e4f33df..e5b0efb 100644
--- a/libdbusmenu-glib/dbus-menu.xml
+++ b/libdbusmenu-glib/dbus-menu.xml
@@ -266,8 +266,20 @@ License version 3 and version 2.1 along with this program. If not, see
</method>
<method name="AboutToShow">
- <arg type="i" name="id" direction="in"></arg>
- <arg type="b" name="needUpdate" direction="out"></arg>
+ <dox:d>
+ This is called by the applet to notify the application that it is about
+ to show the menu under the specified item.
+ </dox:d>
+ <arg type="i" name="id" direction="in">
+ <dox:d>
+ Which menu item represents the parent of the item about to be shown.
+ </dox:d>
+ </arg>
+ <arg type="b" name="needUpdate" direction="out">
+ <dox:d>
+ Whether this AboutToShow event should result in the menu being updated.
+ </dox:d>
+ </arg>
</method>
<!-- Signals -->