[PATCH 09/21] docs: Improve wl_callback protocol docs

[Jason Ekstrand]

On Sat, Mar 30, 2013 at 12:11 AM,  <matthias.clasen at gmail.com> wrote:
> From: Matthias Clasen <mclasen at redhat.com>
>
> Add some information about wl_callback and its done event.
> ---
>  protocol/wayland.xml | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/protocol/wayland.xml b/protocol/wayland.xml
> index ad72fd1..cc009eb 100644
> --- a/protocol/wayland.xml
> +++ b/protocol/wayland.xml
> @@ -157,8 +157,15 @@
>    </interface>
>
>    <interface name="wl_callback" version="1">
> +    <description summary="callback object">
> +      Clients can handle the 'done' event to get notified when
> +      the related request is done.
> +    </description>
>      <event name="done">
> -      <arg name="serial" type="uint"/>
> +      <description summary="done event">
> +       Notify the client when the related request is done.
> +      </description>

That description shouldn't go before an argument, it should go before
the event.  Also, given that there is only one event, I think it's
pretty obvious what it's for so I don't know that the comment is
needed at all.

> +      <arg name="serial" type="uint" summary="serial of the event"/>

The new summary doesn't really add anything.  It might be a good idea
to add some sort of a comment, but it should be more descriptive.

>      </event>
>    </interface>
>
> --
> 1.8.1.4
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel