mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-03-28 07:58:44 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Improve wl_display protocol docs

Browse source 
This adds a bit of information about in-order event delivery,
removes extraneous formatting, and adds a missing period.
This commit is contained in:
Matthias Clasen 2013-03-30 01:11:33 -04:00 • committed by Kristian Høgsberg
parent 8d0b577310
commit a5cc5b32bb
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
protocol/wayland.xml
View file

@ -36,9 +36,10 @@
<request name="sync"> <request name="sync">
<description summary="asynchronous roundtrip"> <description summary="asynchronous roundtrip">
The sync request asks the server to emit the 'done' event The sync request asks the server to emit the 'done' event
on the provided wl_callback object. Since requests are on the returned wl_callback object. Since requests are
handled in-order, this can be used as a barrier to ensure all handled in-order and events are delivered in-order, this can
previous requests have been handled. used as a barrier to ensure all previous requests and the
resulting events have been handled.
</description> </description>
<arg name="callback" type="new_id" interface="wl_callback"/> <arg name="callback" type="new_id" interface="wl_callback"/>
</request> </request>
@ -55,11 +56,11 @@
<event name="error"> <event name="error">
<description summary="fatal error event"> <description summary="fatal error event">
The error event is sent out when a fatal (non-recoverable) The error event is sent out when a fatal (non-recoverable)
error has occurred. The @object_id argument is the object error has occurred. The object_id argument is the object
where the error occurred, most often in response to a request where the error occurred, most often in response to a request
to that object. The @code identifies the error and is defined to that object. The code identifies the error and is defined
by the object interface. As such, each interface defines its by the object interface. As such, each interface defines its
own set of error codes. The @message is an brief description own set of error codes. The message is an brief description
of the error, for (debugging) convenience. of the error, for (debugging) convenience.
</description> </description>
<arg name="object_id" type="object"/> <arg name="object_id" type="object"/>
@ -81,12 +82,12 @@
</enum> </enum>
<event name="delete_id"> <event name="delete_id">
<description summary="acknowledge object id deletion"> <description summary="acknowledge object ID deletion">
This event is used internally by the object ID management This event is used internally by the object ID management
logic. When a client deletes an object, the server will send logic. When a client deletes an object, the server will send
this event to acknowledge that it has seen the delete request. this event to acknowledge that it has seen the delete request.
When the client receive this event, it will know that it can When the client receive this event, it will know that it can
safely reuse the object ID safely reuse the object ID.
</description> </description>
<arg name="id" type="uint" /> <arg name="id" type="uint" />
</event> </event>