[PATCH 1/4] doc: move documentation from the tex file to docbook
peter.hutterer at who-t.net
Thu Mar 29 15:38:38 PDT 2012
On Thu, Mar 29, 2012 at 01:34:40PM +0200, Andreas Ericsson wrote:
> On 03/29/2012 02:50 AM, Peter Hutterer wrote:
> > - "Implementation" section skipped, this seems in need of an update anyway
> > and may be better documented elsewhere (wiki?)
> Why not just use doxygen to document the api? It is *the* reference
> implementation, after all, and in-code comments rarely go as stale as
> external documents meant to describe it.
The API itself is largely documented by the protocol spec which is
autogenerated and linked to from the matching sections. There's a place for
doxygen, but I think there's also a place for an Implementation section to
provide a 'big picture' outline, without the gory details of the API.
The line between the two is thin, I admit though.
More information about the wayland-devel