[Bug 788477] New: gst_object_ref_sink() documentation is confusing

[GStreamer (GNOME Bugzilla)]

https://bugzilla.gnome.org/show_bug.cgi?id=788477

            Bug ID: 788477
           Summary: gst_object_ref_sink() documentation is confusing
    Classification: Platform
           Product: GStreamer
           Version: 1.0.1
                OS: All
            Status: NEW
          Severity: normal
          Priority: Normal
         Component: documentation
          Assignee: gstreamer-bugs at lists.freedesktop.org
          Reporter: aboya at igalia.com
        QA Contact: gstreamer-bugs at lists.freedesktop.org
     GNOME version: ---

The current documentation of gst_object_ref_sink() reads like this:

> Increase the reference count of object , and possibly remove the floating
> reference, if object has a floating reference.
> 
> In other words, if the object is floating, then this call "assumes ownership"
> of the floating reference, converting it to a normal reference by clearing the
> floating flag while leaving the reference count unchanged. If the object is not
> floating, then this call adds a new normal reference increasing the reference
> count by one.

The first paragraph seems to contradict the second one: the first one seems to
claim that the reference count is unconditionally increased, while the second
one
states that is only done if the reference is not currently floating.

-- 
You are receiving this mail because:
You are the QA Contact for the bug.
You are the assignee for the bug.