[PATCH weston] xdg-shell: add description tags where missing

Jasper St. Pierre jstpierre at mecheye.net
Mon Feb 24 08:57:31 PST 2014


Aha. I just sort of assumed that we could have a long description of an
<arg> by using the contents, and it didn't seem to break. I didn't find
anything else doing it. I didn't know we needed a <description>.

Reviewed-by: Jasper St. Pierre <jstpierre at mecheye.net>


On Mon, Feb 24, 2014 at 11:49 AM, Jonny Lamb <jonny.lamb at collabora.co.uk>wrote:

> wayland.dtd specifies the use of the description tags inside entry and
> description so let's use them.
> ---
>  protocol/xdg-shell.xml | 18 ++++++++++++------
>  1 file changed, 12 insertions(+), 6 deletions(-)
>
> diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml
> index a2913c4..f88db49 100644
> --- a/protocol/xdg-shell.xml
> +++ b/protocol/xdg-shell.xml
> @@ -300,12 +300,16 @@
>          0x1000 - 0x1FFF: GNOME
>        </description>
>        <entry name="maximized" value="1" summary="the surface is
> maximized">
> -        A non-zero value indicates the surface is maximized. Otherwise,
> -        the surface is unmaximized.
> +        <description>
> +          A non-zero value indicates the surface is maximized. Otherwise,
> +          the surface is unmaximized.
> +        </description>
>        </entry>
>        <entry name="fullscreen" value="2" summary="the surface is
> fullscreen">
> -        A non-zero value indicates the surface is fullscreen. Otherwise,
> -        the surface is not fullscreen.
> +        <description>
> +          A non-zero value indicates the surface is fullscreen. Otherwise,
> +          the surface is not fullscreen.
> +        </description>
>        </entry>
>      </enum>
>
> @@ -322,8 +326,10 @@
>        <arg name="state_type" type="uint" summary="the state to set"/>
>        <arg name="value" type="uint" summary="the value to change the
> state to"/>
>        <arg name="serial" type="uint" summary="an event serial">
> -        This serial is so the client can know which change_state event
> corresponds
> -        to which request_change_state request it sent out.
> +        <description>
> +          This serial is so the client can know which change_state event
> corresponds
> +          to which request_change_state request it sent out.
> +        </description>
>        </arg>
>      </request>
>
> --
> 1.9.0
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
>



-- 
  Jasper
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/wayland-devel/attachments/20140224/0ac606d9/attachment.html>


More information about the wayland-devel mailing list