[Xcb] [Bug 29655] New: Expand on API docs

bugzilla-daemon at freedesktop.org bugzilla-daemon at freedesktop.org
Wed Aug 18 13:54:32 PDT 2010


           Summary: Expand on API docs
           Product: XCB
           Version: unspecified
          Platform: Other
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: medium
         Component: Library
        AssignedTo: xcb at lists.freedesktop.org
        ReportedBy: hp at pobox.com
         QAContact: xcb at lists.freedesktop.org

Created an attachment (id=37965)
 View: https://bugs.freedesktop.org/attachment.cgi?id=37965
 Review: https://bugs.freedesktop.org/review?bug=29655&attachment=37965

more docs!

This patch adds quite a bit more detail to the API documentation.

It assumes the small docs patch in bug 29599 has been applied.

There are probably some mistakes in here, but hopefully someone more "in the
know" can fix those.

I think it's useful to give a lot more detail about what blocks and what
doesn't, how buffering and flushing works, and even spell out some basic info
about the X protocol. So I tried to put that kind of thing in here.

I copied a few lines of xcbext.h docs from the wiki, but mostly had to write
new docs for it.

These docs could probably still use more info about how to use XCB with
but I haven't sat down and tried to work that out, so I didn't document it.

Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.

More information about the Xcb mailing list