[PATCH] doc: Added API documentation for wl_display_create function.

[Kristian Høgsberg]

On Tue, May 06, 2014 at 03:52:12PM +0530, Srivardhan Hebbar wrote:
> Signed-off-by: Srivardhan Hebbar <sri.hebbar at samsung.com>
> ---
>  src/wayland-server.c |    9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/src/wayland-server.c b/src/wayland-server.c
> index f2b1b42..7b32848 100644
> --- a/src/wayland-server.c
> +++ b/src/wayland-server.c
> @@ -788,6 +788,15 @@ bind_display(struct wl_client *client,
>  				       destroy_client_display_resource);
>  }
>  
> +/** Create Wayland display object.
> + *
> + * \param None
> + * \return The Wayland display object. Null if failed to create
> + *
> + * This creates the wl_display object for the client.

Thanks for adding documentation for this function.  The display object isn't
specific to any client though, so I wouldn't write "for the client".

Kristian

> + *
> + * \memberof wl_display
> + */
>  WL_EXPORT struct wl_display *
>  wl_display_create(void)
>  {
> -- 
> 1.7.9.5
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel