summaryrefslogtreecommitdiffstats
path: root/protocol/wayland.xml
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2013-03-30 01:11:35 -0400
committerKristian Høgsberg <krh@bitplanet.net>2013-04-01 17:40:14 -0400
commitc84155d475db0428398d1db623f8347f5b40db68 (patch)
tree1c09637818b37e97ea46ddfe6dca05e1fa360a48 /protocol/wayland.xml
parentdocs: Improve the wl_registry protocol docs (diff)
downloadwayland-c84155d475db0428398d1db623f8347f5b40db68.tar
wayland-c84155d475db0428398d1db623f8347f5b40db68.tar.gz
wayland-c84155d475db0428398d1db623f8347f5b40db68.tar.bz2
wayland-c84155d475db0428398d1db623f8347f5b40db68.tar.lz
wayland-c84155d475db0428398d1db623f8347f5b40db68.tar.xz
wayland-c84155d475db0428398d1db623f8347f5b40db68.tar.zst
wayland-c84155d475db0428398d1db623f8347f5b40db68.zip
docs: Improve wl_callback protocol docs
Add some information about wl_callback and its done event.
Diffstat (limited to 'protocol/wayland.xml')
-rw-r--r--protocol/wayland.xml9
1 files changed, 8 insertions, 1 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index ad72fd1..cc009eb 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -157,8 +157,15 @@
</interface>
<interface name="wl_callback" version="1">
+ <description summary="callback object">
+ Clients can handle the 'done' event to get notified when
+ the related request is done.
+ </description>
<event name="done">
- <arg name="serial" type="uint"/>
+ <description summary="done event">
+ Notify the client when the related request is done.
+ </description>
+ <arg name="serial" type="uint" summary="serial of the event"/>
</event>
</interface>