[Xcb] XCB documentation effort status update

[Michael Stapelberg]

Hi,

starting a new thread because the old one was getting big.

Status update: I "completed" documentation on 32 functions. With complete I
mean that there is some kind of explanation for all parameters, a description,
a list of possible errors and a 'see also' section. In some places, there are
still TODO entries for missing high-level or detail explanations. Help is
appreciated!

There current patches and manpages are attached to this mail.

There are 17 requests left until I documented all requests which i3 uses. This
is the first milestone in this project and it should be reached by the end of
next week.

Further steps after reaching this milestone are:
1) Document the events.
2) Cleanup the manpage generator code.
3) Look into extending the Doxygen generation code to include the now-existing
   per-field documentation.
4) Get the patch in a clean shape and get it submitted.

If anyone wants to help me in any way, please feel free to contact me.
Proofreading, comments, suggestions, etc. are very welcome.

Best regards,
Michael
-------------- next part --------------
A non-text attachment was scrubbed...
Name: libxcb.patch
Type: application/octet-stream
Size: 14445 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/xcb/attachments/20111126/0a8bc7e3/attachment-0002.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: xcb-proto.patch
Type: application/octet-stream
Size: 54205 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/xcb/attachments/20111126/0a8bc7e3/attachment-0003.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: xcb-manpages-2011-11-26.tar.bz2
Type: application/x-bzip2
Size: 9790 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/xcb/attachments/20111126/0a8bc7e3/attachment-0001.bin>