[RFC wayland] doc: generate doxygen html output from the scanner

[Peter Hutterer]

On Tue, Nov 03, 2015 at 12:37:39PM -0800, Bill Spitzak wrote:
> On Sun, Nov 1, 2015 at 6:21 PM, Peter Hutterer <peter.hutterer at who-t.net>
> wrote:
> 
> > On Sun, Nov 01, 2015 at 05:41:04PM -0800, Bill Spitzak wrote:
> > > On 11/01/2015 04:27 PM, Peter Hutterer wrote:
> > >
> > > >but: the current API docs in publican are useless. look at appendix B,
> > the
> > > >"client API". http://wayland.freedesktop.org/docs/html/apb.html
> > > >it's technically the client API but it's lacking anything that's not
> > core
> > > >libwayland API. it doesn't describe protocol interfaces at all. That's
> > only
> > > >in the protocol spec (Appendix A) and that is generated straight from
> > the
> > > >xml without doxygen's involvement.
> > >
> > > That page is produced by converting doxygen output into docbook input,
> > so it
> > > actually matches what you get from doxygen.
> >
> > But it doesn't scan the actual protocol header, check e.g.
> > scanned_src_files_Server in the makefile.
> >
> 
> It runs doxygen on those source files to produce doxygen xml output (look
> in doc/doxygen/Makefile.am for scanned_src_files). Then in
> doc/publican/Makefile.am it uses doc/publican/doxygen-to-publican.xsl to
> convert that doxygen xml output into docbook input. This mostly preserves
> the doxygen formatting.

the protocol API is in the files wayland-server-protocol.h and
wayland-client-protocol.h. The rest are largely utility functions.

Cheers,
   Peter