[PATCH wayland 4/4] doc: Add auto-generated Wayland Library chapter

David Herrmann dh.herrmann at googlemail.com
Thu Oct 11 14:57:18 PDT 2012

Hi Tiago

On Thu, Oct 11, 2012 at 4:42 PM, Tiago Vignatti
<tiago.vignatti at intel.com> wrote:
> For now only Wayland Client API is described on that chapter, which is
> extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet
> (doxygen-to-publican) on doxygen output so it becomes docbook valid.
> Now all we need to do is populate that header while developing in order to
> grow a decent documentation. So please use it!
> Signed-off-by: Tiago Vignatti <tiago.vignatti at intel.com>
> ---
> What do you think about this really?
> My goal would be to mix the static docbook API descriptions (we have only one
> atm, wl_display_connect.xml) with the auto-generated ones, giving priority for
> the first always. That would give flexibility for expanding the publican book
> and the man pages in the way we want but also keeping the completeness of all
> API documented. I like the idea myself, but I'm really lacking xslt foo for
> building this now :/
> Thanks.

As discussed on IRC I really like this approach. It puts all
documentation into the place where it belongs to. API docs will be
available as doxygen comments in the wayland-headers and we can
generate publican docs and man-pages out of it.
Protocol-documentation will be available in protocol/wayland.xml and
we already use this to create the publican docs. And all the overview
pages can be static XML files in ./doc/ that we can use to create
manpages and publican overview pages.

I will be looking into writing the XSL files to generate the
man-pages. However, it's a mess installing publican here so I will
probably not work on the publican XSL files.


More information about the wayland-devel mailing list