[PATCH wayland] protocol: add better description of wl_pointer.release

Marek Chalupa mchqwerty at gmail.com
Mon Mar 30 03:10:22 PDT 2015


Add note about what all wl_pointer.release does. Mainly that
it destroys the proxy object, so programmer must not call
wl_pointer_destroy() on the pointer any further.

Signed-off-by: Marek Chalupa <mchqwerty at gmail.com>
---
 protocol/wayland.xml | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 041e5f0..f52677f 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1560,7 +1560,13 @@
     <!-- Version 3 additions -->
 
     <request name="release" type="destructor" since="3">
-      <description summary="release the pointer object"/>
+      <description summary="release the pointer object">
+        Using this request client can tell the server that it is not going to
+	use the pointer object anymore.
+
+	This request destroys the pointer proxy object, so user must not call
+	wl_pointer_destroy() after using this request.
+      </description>
     </request>
 
   </interface>
-- 
2.1.0



More information about the wayland-devel mailing list