<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Nov 3, 2015 at 2:02 PM, Peter Hutterer <span dir="ltr"><<a href="mailto:peter.hutterer@who-t.net" target="_blank">peter.hutterer@who-t.net</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div class=""><div class="h5">On Tue, Nov 03, 2015 at 12:37:39PM -0800, Bill Spitzak wrote:<br>
> On Sun, Nov 1, 2015 at 6:21 PM, Peter Hutterer <<a href="mailto:peter.hutterer@who-t.net">peter.hutterer@who-t.net</a>><br>
> wrote:<br>
><br>
> > On Sun, Nov 01, 2015 at 05:41:04PM -0800, Bill Spitzak wrote:<br>
> > > On 11/01/2015 04:27 PM, Peter Hutterer wrote:<br>
> > ><br>
> > > >but: the current API docs in publican are useless. look at appendix B,<br>
> > the<br>
> > > >"client API". <a href="http://wayland.freedesktop.org/docs/html/apb.html" rel="noreferrer" target="_blank">http://wayland.freedesktop.org/docs/html/apb.html</a><br>
> > > >it's technically the client API but it's lacking anything that's not<br>
> > core<br>
> > > >libwayland API. it doesn't describe protocol interfaces at all. That's<br>
> > only<br>
> > > >in the protocol spec (Appendix A) and that is generated straight from<br>
> > the<br>
> > > >xml without doxygen's involvement.<br>
> > ><br>
> > > That page is produced by converting doxygen output into docbook input,<br>
> > so it<br>
> > > actually matches what you get from doxygen.<br>
> ><br>
> > But it doesn't scan the actual protocol header, check e.g.<br>
> > scanned_src_files_Server in the makefile.<br>
> ><br>
><br>
> It runs doxygen on those source files to produce doxygen xml output (look<br>
> in doc/doxygen/Makefile.am for scanned_src_files). Then in<br>
> doc/publican/Makefile.am it uses doc/publican/doxygen-to-publican.xsl to<br>
> convert that doxygen xml output into docbook input. This mostly preserves<br>
> the doxygen formatting.<br>
<br>
</div></div>the protocol API is in the files wayland-server-protocol.h and<br>
wayland-client-protocol.h. The rest are largely utility functions.<br></blockquote><div><br></div><div>I was responding to your complaint that <span class="im">"the current API docs in publican are useless. look at appendix B, the<br>
"client API". <a href="http://wayland.freedesktop.org/docs/html/apb.html" rel="noreferrer" target="_blank">http://wayland.freedesktop.org/docs/html/apb.html</a>"<br><br></span></div><div><span class="im">The document in question is produced by running doxygen on the client api header and source files, then converting it's xml output into docbook. Therefore it is an example of what you get from doxygen and switching to doxygen may not improve things<br><br></span></div><div> <br></div></div></div></div>