docs: Improve wl_callback protocol docs
authorMatthias Clasen <mclasen@redhat.com>
Sat, 30 Mar 2013 05:11:35 +0000 (01:11 -0400)
committerKristian Høgsberg <krh@bitplanet.net>
Mon, 1 Apr 2013 21:40:14 +0000 (17:40 -0400)
Add some information about wl_callback and its done event.

protocol/wayland.xml

index ad72fd1..cc009eb 100644 (file)
   </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>