diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2013-03-30 01:11:33 -0400 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2013-04-01 17:40:14 -0400 |
| commit | a5cc5b32bb2400eefe7b497a0613a2cc23921852 (patch) | |
| tree | 80a3c0af85842336f3caeeffe913fa1275a49263 /protocol | |
| parent | 8d0b57731008b3e7688777da9489238500b8b1b0 (diff) | |
docs: Improve wl_display protocol docs
This adds a bit of information about in-order event delivery,
removes extraneous formatting, and adds a missing period.
Diffstat (limited to 'protocol')
| -rw-r--r-- | protocol/wayland.xml | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml index 9d276f8..8587b8f 100644 --- a/protocol/wayland.xml +++ b/protocol/wayland.xml @@ -36,9 +36,10 @@ <request name="sync"> <description summary="asynchronous roundtrip"> The sync request asks the server to emit the 'done' event - on the provided wl_callback object. Since requests are - handled in-order, this can be used as a barrier to ensure all - previous requests have been handled. + on the returned wl_callback object. Since requests are + handled in-order and events are delivered in-order, this can + used as a barrier to ensure all previous requests and the + resulting events have been handled. </description> <arg name="callback" type="new_id" interface="wl_callback"/> </request> @@ -55,11 +56,11 @@ <event name="error"> <description summary="fatal error event"> 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 - 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 - 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. </description> <arg name="object_id" type="object"/> @@ -81,12 +82,12 @@ </enum> <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 logic. When a client deletes an object, the server will send this event to acknowledge that it has seen the delete request. When the client receive this event, it will know that it can - safely reuse the object ID + safely reuse the object ID. </description> <arg name="id" type="uint" /> </event> |