diff options
| author | Tiago Vignatti <tiago.vignatti@intel.com> | 2012-04-16 17:31:40 +0300 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2012-04-16 11:54:14 -0400 |
| commit | 7bef06654f8321193500c527039816efe5d6f9f7 (patch) | |
| tree | fedc637187e2375227ee082198b7c9a06b227244 /protocol | |
| parent | eb04ddb1b651543a46e7d2b87ff3a43070eb8579 (diff) | |
| download | weston-7bef06654f8321193500c527039816efe5d6f9f7.tar.gz weston-7bef06654f8321193500c527039816efe5d6f9f7.tar.bz2 weston-7bef06654f8321193500c527039816efe5d6f9f7.zip | |
desktop-shell: use description tags and improve protocol doc a bit
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
Diffstat (limited to 'protocol')
| -rw-r--r-- | protocol/desktop-shell.xml | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/protocol/desktop-shell.xml b/protocol/desktop-shell.xml index 836b1278..d2bb3eb0 100644 --- a/protocol/desktop-shell.xml +++ b/protocol/desktop-shell.xml @@ -1,6 +1,12 @@ <protocol name="desktop"> <interface name="desktop_shell" version="1"> + <description summary="create desktop widgets and helpers"> + Traditional user interfaces can rely on this interface to define the + foundations of typical desktops. Currently it's possible to set up + background, panels and locking surfaces. + </description> + <request name="set_background"> <arg name="output" type="object" interface="wl_output"/> <arg name="surface" type="object" interface="wl_shell_surface"/> @@ -26,21 +32,28 @@ <arg name="height" type="int"/> </event> - <!-- Tell the shell we want it to create and set the lock surface, - which is a GUI asking the user to unlock the screen. The lock - surface is announced with 'set_lock_surface'. Whether or not - the shell actually implements locking, it MUST send 'unlock' - request to let the normal desktop resume. --> - <event name="prepare_lock_surface"/> + <event name="prepare_lock_surface"> + <description summary="tell the client to create, set the lock surface"> + Tell the shell we want it to create and set the lock surface, which is + a GUI asking the user to unlock the screen. The lock surface is + announced with 'set_lock_surface'. Whether or not the shell actually + implements locking, it MUST send 'unlock' request to let the normal + desktop resume. + </description> + </event> </interface> - <!-- Only one client can bind this interface at a time. --> <interface name="screensaver" version="1"> + <description summary="interface for implementing screensavers"> + Only one client can bind this interface at a time. + </description> - <!-- Set the surface type as a screensaver for a particular output. - A screensaver surface is normally hidden, and only visible after - an idle timeout. --> <request name="set_surface"> + <description summary="set the surface type as a screensaver"> + A screensaver surface is normally hidden, and only visible after an + idle timeout. + </description> + <arg name="surface" type="object" interface="wl_shell_surface"/> <arg name="output" type="object" interface="wl_output"/> </request> |