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

[Pekka Paalanen]

On Tue, 06 May 2014 17:21:23 +0530
Srivardhan <sri.hebbar at samsung.com> wrote:

> 
> 
> > -----Original Message-----
> > From: wayland-devel [mailto:wayland-devel-
> > bounces at lists.freedesktop.org] On Behalf Of Pekka Paalanen
> > Sent: Tuesday, May 06, 2014 5:03 PM
> > To: Srivardhan Hebbar
> > Cc: wayland-devel at lists.freedesktop.org
> > Subject: Re: [PATCH] doc: Added API documentation for
> > wl_display_create function.
> > 
> > On Tue, 06 May 2014 15:52:12 +0530
> > Srivardhan Hebbar <sri.hebbar at samsung.com> 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.
> > 
> > Hi,
> > 
> > this is a server function, not a client function.
> > 
> > FYI, struct wl_display is a different thing in server vs. client,
> > and I
> think there
> > might even be a third definition in clients that is a wl_proxy.
> 
> Oops... My bad. Sorry. This function creates the wl_display singleton
> object for the server. Right? Would correct it update the patch.

Yeah, but I don't think it has to be a singleton, either. I mean,
nothing inside libwayland-server requires it to be a singleton AFAIK.
It just isn't too useful to run multiple separated servers in one
process, but nothing prevents that.


Thanks,
pq

> > > + *
> > > + * \memberof wl_display
> > > + */
> > >  WL_EXPORT struct wl_display *
> > >  wl_display_create(void)
> > >  {