diff options
| author | Yong Bakos <ybakos@humanoriented.com> | 2016-04-11 17:23:04 -0500 |
|---|---|---|
| committer | Bryce Harrington <bryce@bryceharrington.org> | 2016-04-13 12:35:15 -0700 |
| commit | 6c6e646a484478ed4577c79d1c6c29ca34bd11e5 (patch) | |
| tree | f41dadd67d3f2802b9b6b06d4883cc13806d31bc | |
| parent | ae55234c536cd3cc06555981477e7a9eb2f92cce (diff) | |
fullscreen-shell: Correct grammar, punctuation, minor naming and space
Add missing periods that terminate sentences.
Correct ARBITRARY_MODE to match the actual enum value name.
Adjust one post-period space to match the rest of the content.
Downcase summary description to match the rest of the document.
Add line breaks between sequential enum elements to match conventions
in this, and other, protocol xml docs.
Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
| -rw-r--r-- | unstable/fullscreen-shell/fullscreen-shell-unstable-v1.xml | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/unstable/fullscreen-shell/fullscreen-shell-unstable-v1.xml b/unstable/fullscreen-shell/fullscreen-shell-unstable-v1.xml index 93f95b8..4530938 100644 --- a/unstable/fullscreen-shell/fullscreen-shell-unstable-v1.xml +++ b/unstable/fullscreen-shell/fullscreen-shell-unstable-v1.xml @@ -1,6 +1,7 @@ <protocol name="fullscreen_shell_unstable_v1"> + <interface name="zwp_fullscreen_shell_v1" version="1"> - <description summary="Displays a single surface per output"> + <description summary="displays a single surface per output"> Displays a single surface per output. This interface provides a mechanism for a single client to display @@ -14,7 +15,7 @@ details about scaling and mode switches. The client can have at most one surface per output at any time. - Requesting a surface be presented on an output that already has a + Requesting a surface to be presented on an output that already has a surface replaces the previously presented surface. Presenting a null surface removes its content and effectively disables the output. Exactly what happens when an output is "disabled" is @@ -38,7 +39,7 @@ <request name="release" type="destructor"> <description summary="release the wl_fullscreen_shell interface"> - Release the binding from the wl_fullscreen_shell interface + Release the binding from the wl_fullscreen_shell interface. This destroys the server-side object and frees this binding. If the client binds to wl_fullscreen_shell multiple times, it may wish @@ -52,7 +53,7 @@ are advertised one-at-a-time when the wl_fullscreen_shell interface is bound. See the wl_fullscreen_shell.capability event for more details. - ARBITRARY_MODE: + ARBITRARY_MODES: This is a hint to the client that indicates that the compositor is capable of setting practically any mode on its outputs. If this capability is provided, wl_fullscreen_shell.present_surface_for_mode @@ -174,7 +175,7 @@ <enum name="error"> <description summary="wl_fullscreen_shell error values"> - These errors can be emitted in response to wl_fullscreen_shell requests + These errors can be emitted in response to wl_fullscreen_shell requests. </description> <entry name="invalid_method" value="0" summary="present_method is not known"/> </enum> @@ -191,16 +192,18 @@ wl_fullscreen_shell_mode_feedback object. </description> </event> + <event name="mode_failed"> <description summary="mode switch failed"> This event indicates that the attempted mode switch operation - failed. This may be because the requested output mode is not + failed. This may be because the requested output mode is not possible or it may mean that the compositor does not want to allow it. Upon receiving this event, the client should destroy the wl_fullscreen_shell_mode_feedback object. </description> </event> + <event name="present_cancelled"> <description summary="mode switch cancelled"> This event indicates that the attempted mode switch operation was @@ -212,4 +215,5 @@ </description> </event> </interface> + </protocol> |