[PATCH 09/21] docs: Improve wl_callback protocol docs

matthias.clasen at gmail.com matthias.clasen at gmail.com
Fri Mar 29 22:11:35 PDT 2013


From: Matthias Clasen <mclasen at redhat.com>

Add some information about wl_callback and its done event.
---
 protocol/wayland.xml | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

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>
 
-- 
1.8.1.4



More information about the wayland-devel mailing list