Wayland client API reference document

[Tiago Vignatti]

Hi,

On 10/17/2012 02:47 PM, Venkataramana Kotakonda wrote:
>
> Am new to linux graphics and wayland . I’m trying to write a small
> wayland client application which can display some photo(PNG images).
>
> I’m able to use the sample client programs in weston source. I couldn’t
>   find proper wayland client API document for reference so that I can
> understand the functionality of each client API in detail and use them
> effectively.
>
> Please reply where can I find the documents.

We're at the moment working on the documentation, aiming useful 
man-pages, pdf and html to the 1.0 release. In the mean time, you can 
dig on the source code which is using doxygen syntax and also take a 
look on the API Wayland exposes to clients:

http://cgit.freedesktop.org/wayland/wayland/tree/src/wayland-client.c
http://wayland.freedesktop.org/docs/html/chap-Library.html

FYI, now we're working in ways to extract the doxygen commentaries to a 
docbook XML (which eventually will be converted to publican, man-page, 
pdf, etc). Would be good to hear any feedback you can give regarding 
this documentation.

And fresh also, is a post I just wrote about this subject. You might 
want to take a look:
http://vignatti.wordpress.com/2012/10/17/the-damn-small-wayland-api/

Thank you,

     Tiago