[Wayland-bugs] [Bug 83479] New: Document wl_proxy user data surprises

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=83479

          Priority: medium
            Bug ID: 83479
          Assignee: wayland-bugs at lists.freedesktop.org
            Blocks: 83429
           Summary: Document wl_proxy user data surprises
          Severity: enhancement
    Classification: Unclassified
                OS: All
          Reporter: ppaalanen at gmail.com
          Hardware: All
            Status: NEW
           Version: unspecified
         Component: wayland
           Product: Wayland

People get surprised, that for a wl_proxy:
- add_listener can only be used once, so it's more a "init", not "add"
- add_listener sets the same user data as set_user_data does

Might as well review that all aspect of the user data are documented.

This should be both in the per-function doc comments picked up by Doxygen, and
when a "big docs" chapter about the client side API gets started, there.

-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/wayland-bugs/attachments/20140904/b6e778b3/attachment.html>