[Xcb] doxygen doc of the API

[Vincent Torri]

hey,

the patch is in bugzilla.

Vincent


On Fri, 3 Mar 2006, Jamey Sharp wrote:

> On Tue, Feb 28, 2006 at 09:40:21PM +0100, Vincent Torri wrote:
> >  Here is a small example of the documentation:
> >
> > http://www.iecn.u-nancy.fr/~torri/files/xcb/xcb_api.tar.bz2
>
> Awesome, thanks for the sample.
>
> Note that XCBGenericRep is a generic reply, not a generic response. The
> term "response" is used to refer to any reply, error, or event.
>
> Were you planning on including documentation on internal APIs here? If
> not, it's kind of weird that the file list has xcbint.h and all the
> source files. It should arguably cover only xcb.h, xcbext.h, and
> xcbxlib.h. Possibly it should also cover xproto.h and others, but only
> if you can auto-generate part or all of that documentation from the
> original XML.
>
> >  i also would like to add some presentation on the main page. For example:
> >
> >  * general presentation (from the wiki)
> >  * a small example of code
> >  * something else ?
>
> I think your tutorial is the place for code samples, etc. A link to your
> tutorial wouldn't be a bad thing for the main page of the API
> documentaiton though.
>
> >  we can add some todo items, if some functions need to.
>
> I'm not sure I understand this. You mean if the functions have planned
> interface changes? At this point, if I could remember that I planned to
> change the interface, I've done it already.
>
> --Jamey
>