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

[Ander Conselvan de Oliveira]

On 05/06/2014 04:17 PM, Ander Conselvan de Oliveira wrote:
> On 05/06/2014 01:22 PM, 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.
>> + *
>> + * \memberof wl_display
>
> We have two objects named wl_display, and the one that is documented as
> \class wl_display is the client side one. I'm not sure how to tell
> doxygen that these are two separate things. A quick Google search
> suggested \addtogroup might help, but I haven't really checked if that
> is what we want.

Never mind. We actually do two separate doxygen passes, one for the 
server source files and one for the client source files, so this is 
already separate.


>
> Cheers,
> Ander
>
>> + */
>>   WL_EXPORT struct wl_display *
>>   wl_display_create(void)
>>   {
>>
>